Status Callbacks
Enumerations
- OmniClientConnectionStatus
Connection Status.
- OmniClientFileStatus
File Status.
Functions
- char const * omniClientGetConnectionStatusString(OmniClientConnectionStatus connectionStatus)
Retrieve a human readable string for a connection status.
- char const * omniClientGetFileStatusString(OmniClientFileStatus fileStatus)
Retrieve a human readable string for a file status.
- uint32_t omniClientRegisterConnectionStatusCallback(void *userData, OmniClientConnectionStatusCallback callback)
Register a callback to receive connection status updates.
- uint32_t omniClientRegisterFileStatusCallback(void *userData, OmniClientFileStatusCallback callback)
Register a callback to receive file transfer updates.
- void omniClientUnregisterCallback(uint32_t handle)
Unregister a callback.
Typedefs
- OmniClientConnectionStatusCallback
This is called any time any connection status changes.
- OmniClientFileStatusCallback
This is called any time any file status changes.
Enumerations
-
enum OmniClientConnectionStatus
Connection Status.
Valid transitions: Disconnected -> Connecting or InvalidHost Connecting -> All except Disconnected Connected -> Disconnected or SignedOut
Values:
-
enumerator eOmniClientConnectionStatus_Connecting
Attempting to connect.
-
enumerator eOmniClientConnectionStatus_Connected
Successfully connected.
-
enumerator eOmniClientConnectionStatus_ConnectError
Error while trying to connect.
-
enumerator eOmniClientConnectionStatus_Disconnected
Disconnected after a successful connection.
-
enumerator eOmniClientConnectionStatus_SignedOut
omniClientSignOut called
-
enumerator eOmniClientConnectionStatus_NoUsername
No username was provided (This status is no longer used)
-
enumerator eOmniClientConnectionStatus_AuthAbort
Application returned an abort code in the callback provided to omniClientRegisterAuthCallback.
-
enumerator eOmniClientConnectionStatus_AuthCancelled
User clicked “Cancel” or the application called omniClientAuthenticationCancel.
-
enumerator eOmniClientConnectionStatus_AuthError
Internal error while trying to authenticate.
-
enumerator eOmniClientConnectionStatus_AuthFailed
Authentication failed.
-
enumerator eOmniClientConnectionStatus_ServerIncompatible
The server is not compatible with this version of the client library.
-
enumerator eOmniClientConnectionStatus_InvalidHost
The host name is invalid.
-
enumerator Count_eOmniClientConnectionStatus
-
enumerator eOmniClientConnectionStatus_Connecting
-
enum OmniClientFileStatus
File Status.
Values:
-
enumerator eOmniClientFileStatus_Reading
Reading a file.
-
enumerator eOmniClientFileStatus_Writing
Writing a file.
-
enumerator eOmniClientFileStatus_Copying
Copying a file. The url is the source url.
-
enumerator eOmniClientFileStatus_Moving
Moving a file. The url is the source url.
-
enumerator eOmniClientFileStatus_Deleting
Deleting a file.
-
enumerator eOmniClientFileStatus_Obliterating
Obliterating a file.
-
enumerator eOmniClientFileStatus_LiveUpdateSending
Deprecated. Use omniClientLiveRegisterQueuedCallback2.
-
enumerator eOmniClientFileStatus_LiveUpdateReceived
Deprecated. Use omniClientLiveRegisterQueuedCallback2.
-
enumerator eOmniClientFileStatus_Listing
Performing a ‘list’ operation.
-
enumerator eOmniClientFileStatus_Stating
Performing a ‘stat’ operation.
-
enumerator Count_eOmniClientFileStatus
-
enumerator eOmniClientFileStatus_Reading
Functions
-
char const *omniClientGetConnectionStatusString(OmniClientConnectionStatus connectionStatus)
Retrieve a human readable string for a connection status.
-
char const *omniClientGetFileStatusString(OmniClientFileStatus fileStatus)
Retrieve a human readable string for a file status.
-
uint32_t omniClientRegisterConnectionStatusCallback(void *userData, OmniClientConnectionStatusCallback callback)
Register a callback to receive connection status updates.
If you are already connected to a server when you call this function, you will receive a connection status callback for that connection.
- Returns
a handle that you can use with omniClientUnregisterCallback
-
uint32_t omniClientRegisterFileStatusCallback(void *userData, OmniClientFileStatusCallback callback)
Register a callback to receive file transfer updates.
You will receive a callback each time a file transfer starts or stops. This is intended to be used to display loading progress bars and such.
- Returns
a handle that you can use with omniClientUnregisterCallback
-
void omniClientUnregisterCallback(uint32_t handle)
Unregister a callback.
After this function returns, your callback is guaranteed to never be called again.
- Parameters
handle – The handle that was returned from either omniClientRegisterConnectionStatusCallback or omniClientRegisterFileStatusCallback
Typedefs
-
typedef void (*OmniClientConnectionStatusCallback)(void *userData, char const *url, OmniClientConnectionStatus status)
This is called any time any connection status changes.
url does not include path components, for example it could be “omniverse://sandbox.ov.nvidia.com” or “http://nvidia.com”
-
typedef void (*OmniClientFileStatusCallback)(void *userData, char const *url, OmniClientFileStatus status, int percentage)
This is called any time any file status changes.