ParsecClientGetStatus
ParsecStatusParsecClientGetStatus(Parsec *ps,ParsecClientStatus *status)
Get client connection health and status information.
This function should be polled frequently during runtime to check if a client session has completed its connection or is in an error state. If the client is in an error state, a ParsecStatus
error value will continue to be returned until the next call to ParsecClientNewAttempt
or ParsecClientDisconnect
.
Parameters
Direction | Name | Description |
---|---|---|
in | ps | Parsec instance returned by ParsecInit . |
out | status | Client connection health and status information. May be NULL . |
Returns
PARSEC_NOT_RUNNING
if there is no active connection, PARSEC_CONNECTING
if a connection attempt is underway, PARSEC_OK
if the client is connected to a host and healthy, otherwise a ParsecStatus
error value if the client is in an error state.