Enums

enum mi::bridge::Client_job_state

Job states of Bridge jobs. Execution of Bridge jobs often involves uploads to the server which can take a considerable time. Each Bridge job goes through a sequence of states defined by this enum, starting in the state CLIENT_JOB_DETECTING_CHANGES and then progressing to the next state when some conditions are met until the job execution is done and the job ends up in the state CLIENT_JOB_DONE. States will always progress to the next state in the defined order, but some states might be skipped if there is no work that needs to be done in that state. Note that a lot of work is done in parallel so while the job is still determining which elements that needs to be updated, it will also query the cache status and start uploading data for cache misses, etc.

See also:

mi::bridge::IClient_job_progress::get_state()

Enumerator:

CLIENT_JOB_DETECTING_CHANGES = 0

Detecting which database elements needs to be updated before executing the job.

CLIENT_JOB_PREPARING = 1

Calculates hashes for the elements that will be updated and to some extent serialize data that will be sent inline.

CLIENT_JOB_QUERYING_CACHE_STATUS = 2

Determining how much data needs to be uploaded before executing this job. The elements that need to be updated is now known, but there are still pending cache status requests. The job might not enter this state if no cache status requests were needed, or if all requests were already answered while in state CLIENT_JOB_PREPARING.

CLIENT_JOB_UPLOADING = 3

Uploading data. There are no pending cache status requests left and it is known how much data needs to be uploaded before executing the job. The job does not enter this state if there were no cache misses or if all data was already uploaded in previous states.

CLIENT_JOB_PENDING = 4

Waiting for execution of the job to finish. All data needed by the job is now uploaded and the job is either executing on the server or waiting for all previous jobs to finish before it can start executing. To get progress feedback in this state it is possible for the server-side job to send partial results back to the client.

CLIENT_JOB_DONE = 5

The result has been received and deserialized by the client-side job and the job is done.

CLIENT_JOB_FORCE_32_BIT = 0xffffffffU

enum mi::bridge::Client_session_state

The different states a client session can be in.

See also:

mi::bridge::IClient_session::get_state()

Enumerator:

CLIENT_SESSION_CONNECTING

The session is trying to establish a connection to the remote Bridge application for the first time.

CLIENT_SESSION_CONNECTED

The session has successfully established a connection to the Bridge server and is ready for use.

CLIENT_SESSION_PENDING

The session was disconnected unexpectedly. The session cannot be used in this state, but will automatically attempt to reconnect and resume the session. Session resume is only possible if the corresponding server-side session is still available when reconnecting, if not the session will be closed.Note that session resume is currently not supported so disconnected sessions will always be closed.

CLIENT_SESSION_CLOSED

The session has been closed in an orderly fashion, or the session has been pending but the session could not be resumed. Once a session has been closed it can not be used anymore. To attempt a reconnection a new session must be opened.