Broker 10.5 | webMethods Broker Documentation | webMethods Broker Client C API Programmer's Guide | API Reference | awNew | awNewBrokerClient
 
awNewBrokerClient
BrokerError awNewBrokerClient(
char *broker_host,
char *broker_name,
char *client_id,
char *client_group,
char *app_name,
BrokerConnectionDescriptor desc,
BrokerClient *client);
broker_host
The name of the host running the Broker that the new Broker client will use. Specified in the form <broker_host_name>:<port_number>. If you omit the port number, the default port number will be used. For example: MyHost:12000
broker_name
The name of the Broker to which the new Broker client will be connected. If NULL, the default Broker will be used. If specified, the length of this parameter must be 1 to 255 ANSI characters or 1 to 42 Unicode characters.
client_id
A string containing a unique identifier for the new Broker client to be used when disconnecting or reconnecting. If NULL, the Broker will generate a unique client identifier. A NULL value is usually supplied for clients whose life cycle is destroy-on-disconnect. See Client Identifiers for more information.
client_group
The name of the client group for the new Broker client. Client groups are discussed in Administering webMethods Broker .
app_name
The name of the application that will contain the new Broker client.
desc
The connection descriptor to use for the new Broker client. If NULL, a default connection will be established for the new client, which may be shared with other Broker clients.
client
A pointer to the newly created BrokerClient. This parameter is used for output.
Creates a client. broker_name can be NULL to request the default Broker. client_id can be NULL to request the Broker to create an identifier (usually used with destroy-on-disconnect clients). desc can be NULL to create a default connection.
The caller is responsible for calling awDestroyClient on the output value.
Possible BrokerError major codes
Meaning
AW_ERROR_BROKER_NOT_RUNNING
A Broker could not be found on the specified broker_host.
AW_ERROR_CLIENT_EXISTS
Another Broker client is using the specified client_id.
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_CLIENT_ID
The client_id contains invalid characters.
AW_ERROR_INVALID_DESCRIPTOR
The desc parameter is invalid.
AW_ERROR_NO_PERMISSION
Permission to join the client_group was denied.
AW_ERROR_NULL_PARAM
The broker_host, client_group, app_name, or client parameter 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_GROUP
The specified client_group 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.
See also: