broker_host | The name of the host running the Broker that the Broker client will use. Specified in the form <broker_host_name>:<port_number>. If the port number is omitted, the default port number will be used. For example: MyHost:12000 |
broker_name | The name of the Broker. If set to NULL, the default Broker name is used. If specified, the length of this parameter must be 1 to 255 ANSI characters or 1 to 42 Unicode characters. |
client_id | The client identifier, identifying the Broker client as the one that was previously disconnected. See
Client Identifiers for more information. |
desc | The connection descriptor to use for the Broker client. If set to NULL, a default connection will be established which may be shared with other clients. |
client | A pointer to the Broker client. This parameter is used for output. |
Possible BrokerError major codes | Meaning |
AW_ERROR_BROKER_NOT_RUNNING | A Broker with broker_name could not be found on the specified broker_host. |
AW_ERROR_CLIENT_CONTENTION | Another Broker client is using the specified client_id. For clients with shared state, this error is returned if the maximum number of reconnected clients has been exceeded. |
AW_ERROR_COMM_FAILURE | A problem occurred during connection establishment. |
AW_ERROR_HOST_NOT_FOUND | The broker_host could not be found. |
AW_ERROR_INVALID_DESCRIPTOR | The desc parameter is invalid. |
AW_ERROR_NO_PERMISSION | Permission to join the specified client_group was denied. |
AW_ERROR_NULL_PARAMETER | The broker_host or client_id is NULL. |
AW_ERROR_SECURITY | A secure connection was attempted, but was rejected by the Broker. |
AW_ERROR_UNKNOWN_BROKER_NAME | The specified broker_name does not exist. If broker_name is NULL, this indicates that there is no default Broker. |
AW_ERROR_UNKNOWN_CLIENT_ID | The specified client_id does not exist on the Broker. |
AW_ERROR_BASIC_AUTH_FAILURE | Basic authentication failed for the user. |
AW_ERROR_INVALID_BASICAUTH_VALUE | You did not specify a password for the basic authentication user. |