Error Definitions
This appendix contains the major error codes that you might encounter when using the C Library.
You can use the
awErrorToString method to obtain a character string that briefly describes the error associated with a particular
BrokerError.
The
awErrorToCompleteString method lets you obtain a character string that specifically describes the error associated with a particular
BrokerError.
AW_ERROR_BAD_STATE
You invoked an API function that conflicts with the current system state. For example:
You attempted to register a callback for a subscription ID before registering a general callback.
You attempted to invoke the
awDispatch function within a callback function.
AW_ERROR_BROKER_FAILURE
An unexpected failure occurred while the Broker was processing your request. This error can have two possible meanings:
The API could not correctly process an error into one of the other errors.
A
Broker failure has occurred, such as running out of memory or a corrupted data store.
AW_ERROR_BROKER_NOT_RUNNING
While attempting to create or reconnect a Broker client, the specified host was found but no Broker was running on that host.
AW_ERROR_CLIENT_CONTENTION
On reconnect Broker client calls, the client is either already in use, or the client has shared state and the maximum has already been reached.
AW_ERROR_CLIENT_EXISTS
The client ID specified when creating a new Broker client is already is use.
AW_ERROR_COMM_FAILURE
A generic communications fault has occurred. Network failures cause this error to be returned.
AW_ERROR_CONNECTION_CLOSED
The connection to the Broker was closed before or during the operation you requested.
AW_ERROR_CORRUPT
The data object on which you are operating is corrupt. Currently only detected on BrokerEvent objects.
AW_ERROR_FIELD_NOT_FOUND
Attempt to operate on a BrokerEvent field that does not exist.
AW_ERROR_FIELD_TYPE_MISMATCH
The specified event field is not of the expected type. For example, using the awSetStringField function on an event field of type int will generate this error.
AW_ERROR_FILE_NOT_FOUND
The specified file could not be found or could not be opened.
AW_ERROR_FILTER_PARSE
An error occurred while parsing the filter string specified when creating a new filter with the awNewBrokerFilter function.
AW_ERROR_FILTER_RUNTIME
A runtime error, such as division by zero, occurred while parsing the filter specified with the awMatchFilter function.
AW_ERROR_FORMAT
This can result from some protocol failures. It is mainly issued by the BrokerString calls to parse values out of strings.
AW_ERROR_HOST_NOT_FOUND
The host specified with the awNewBrokerClient function or the awReconnectBrokerClient function could not be located.
AW_ERROR_INCOMPATIBLE_VERSION
The Broker is running an older version of the product than this library.
AW_ERROR_INTERRUPTED
An invocation of awGetEvent, awGetEvents, awGetEventsWithAck, or awDispatch was interrupted by the invocation of the awInterruptGetEvents or the awInterruptDispatch function.
AW_ERROR_INVALID_ACKNOWLEDGEMENT
An attempt was made to acknowledge a sequence number that was out of order or which was not been assigned to your Broker client.
AW_ERROR_INVALID_CLIENT
The BrokerClient passed to the function is either disconnected or destroyed.
AW_ERROR_INVALID_CLIENT_ID
The client ID passed to the function contained illegal characters. See
Parameter Naming Rules for details on the proper format of client identifiers.
AW_ERROR_INVALID_DESCRIPTOR
The BrokerConnectionDescriptor object passed to the function has been deleted.
AW_ERROR_INVALID_EVENT
The BrokerEvent object passed to the function has been deleted.
AW_ERROR_INVALID_EVENT_TYPE_NAME
The event type name contains illegal characters, reserved words, or has components over 255 characters in length. See
Parameter Naming Rules for details on the proper format of event type names.
AW_ERROR_INVALID_FIELD_NAME
The field name contains illegal characters, reserved words, or has components over 255 characters in length. See
Parameter Naming Rules for details on the proper format of event type names.
AW_ERROR_INVALID_FILTER
The BrokerFilter object passed to the function has been deleted.
AW_ERROR_INVALID_PORT
The specified port number contains invalid characters or is out of range.
AW_ERROR_INVALID_SUBSCRIPTION
The subscription requested with the awNewSubscription function contained a null event_type_name parameter, a negative subscription ID, or a filter string that could not be parsed.
This error may also be returned if the subscription passed to the awCancelSubscription function could not be found by the Broker.
AW_ERROR_INVALID_TYPE
An attempt was made to set an event field, using a function such as awSetField, to a value that did not match the field's type.
This error may also be reported if an internal failure is encountered by the API.
AW_ERROR_INVALID_TYPECACHE
An internal error occurred with the event type definition cache. This is does not represent a user error.
AW_ERROR_INVALID_TYPEDEF
The BrokerTypeDef object passed to the function has been deleted. Either the client with which it was associated was disconnected or destroyed, or the cache was flushed.
AW_ERROR_NO_MEMORY
Ran out of memory while trying to complete the requested operation
AW_ERROR_NO_PERMISSION
You do not have the necessary permission to do the operation you attempted. For example:
Attempting to write to a read-only envelope field.
Using a client group that does not contain your identity with the correct permissions when reconnecting or creating a new
BrokerClient.
Attempting to publish an event type that is not allowed by your
BrokerClient object's client group.
For more information on client group permissions and can publish permissions see Administering webMethods Broker.
AW_ERROR_NOT_IMPLEMENTED
The requested function call is not implemented.
AW_ERROR_NULL_PARAM
A null value was passed for a parameter that requires a value.
AW_ERROR_OUT_OF_RANGE
A parameter value is outside the accepted range. For example, getting a sequence subset using negative indexes will return this error.
AW_ERROR_PROTOCOL
Internal failure communicating with the Broker.
AW_ERROR_SECURITY
A security problem was encountered that prevented the operation from being completed.
AW_ERROR_SUBSCRIPTION_EXISTS
You attempted to create a new subscription with the awNewSubscription function, using an event type and filter that has already been used for another subscription.
AW_ERROR_TIMEOUT
This error is returned by functions such as awGetEvent when an event is not received within the specified time-out interval.
AW_ERROR_UNKNOWN_BROKER_NAME
The Broker whose name was specified on a call to the awNewBrokerClient or awReconnectBrokerClient function was not found.
AW_ERROR_UNKNOWN_CLIENT_GROUP
The client group specified on a call to the awNewBrokerClient or awReconnectBrokerClient function was not found.
AW_ERROR_UNKNOWN_CLIENT_ID
The client ID specified on a call to the awReconnectBrokerClient was not found.
AW_ERROR_UNKNOWN_EVENT_TYPE
The specified event type was not found on the Broker. For example, calling the awNewBrokerEvent function on a non-existent type.
AW_ERROR_UNKNOWN_INFOSET
The specified infoset was not found for the event type.
AW_ERROR_UNKNOWN_KEY
There platform key specified on a call to the awGetPlatformInfo function has no defined value.
AW_ERROR_UNKNOWN_NAME
The specified distinguished name does not exist in the appropriate certificate file.