Group Services Programming Guide and Reference

GSAPI errors (err_gsapi)

Purpose

GSAPI Errors and Return Codes - Error numbers and return codes for the Group Services Application Programming Interface (GSAPI)

Description

The Group Services Application Programming Interface (GSAPI) provides error numbers and return codes that may be returned either synchronously or asynchronously. Synchronous information is returned immediately from a subroutine when it is unsuccessful. Asynchronous information is returned through the delayed error callback routine, when the error condition is detected at a later time.

The GSAPI error numbers and return codes are defined in the ha_gs.h header file, as follows:

HA_GS_BAD_GROUP_ATTRIBUTES

The group attributes that were specified on a call to the ha_gs_join subroutine are either invalid or do not the match the group attributes that were specified by the providers that already belong to the group.

This error number is returned either synchronously or asynchronously, depending on when the error was detected.

HA_GS_BAD_MEMBER_TOKEN

The specified token does not represent a valid provider or subscriber instance for this client.

This error number is returned synchronously.

HA_GS_BAD_PARAMETER

The specified parameter was not valid.

This error number is returned either synchronously or asynchronously, depending on when the error was detected.

HA_GS_BACKLEVEL_PROVIDERS

A protocol request was made, and the group contains active providers that were compiled against an older level of the Group Services client interface library. This level does not support the new protocol request.

This error number is returned asynchronously.

HA_GS_COLLIDE

Another protocol is already active for this group.

This error number can be returned either synchronously or asynchronously, depending on when the error was detected. This error number is returned in response to the protocol requests resulting from calls to the following subroutines: ha_gs_change_state_value, ha_gs_change_attributes, ha_gs_expel, ha_gs_send_message, and ha_gs_leave.

HA_GS_CONNECT_FAILED

The Group Services subsystem could not complete the connection. Possible causes are: the Group Services daemon is not running, or it is not ready to accept connections.

This error number is returned synchronously.

HA_GS_DUPLICATE_INSTANCE_NUMBER

The provider instance number that was specified on a call to the ha_gs_join subroutine is already in use for this group on this node.

This error number is returned asynchronously through the delayed error callback routine.

HA_GS_EXISTS

The GSAPI has already been initialized by a previous call to the ha_gs_init subroutine.

This error number is returned synchronously.

HA_GS_INVALID_DEACTIVATE_PHASE

The process specified a phase other than 0 or 1 on the call to the ha_gs_expel subroutine for a one-phase expel protocol.

This error number is returned synchronously.

HA_GS_INVALID_GROUP

The process does not have permission to join the group that was specified on the call to the ha_gs_join subroutine. For example, this error number is returned in response to an attempt to join a system-defined group such as the host membership group or an adapter membership group.

This error number is returned asynchronously through the delayed error callback routine.

HA_GS_INVALID_SOURCE_GROUP

The process specified an invalid source group on the call to the ha_gs_join subroutine. For example, this error number is returned in response to an attempt to specify as a source group a system-defined group such as the host membership group or an adapter membership group.

This error number is returned synchronously.

HA_GS_NAME_TOO_LONG

A name string was specified that was longer than that given by the HA_GS_MAX_GROUP_NAME_LENGTH symbolic constant.

This error number is returned synchronously.

HA_GS_NO_INIT

An attempt was made to use the GSAPI without initializing it by calling the ha_gs_init subroutine.

This error number is returned synchronously.

HA_GS_NO_MEMORY

The Group Services subsystem could not allocate required memory.

This error number is returned synchronously.

HA_GS_NO_SOURCE_GROUP_PROVIDER

A call to the ha_gs_join subroutine specified a source-group name, and there is no provider from that source-group already active on this node.

This error number is returned asynchronously through the delayed error callback routine.

HA_GS_NOT_A_MEMBER

The provider that is proposing the protocol is no longer a provider for the specified group.

This error number is returned asynchronously through the delayed error callback routine. It is returned in response to the protocol requests resulting from calls including the following subroutines: ha_gs_change_state_value, ha_gs_send_message, and ha_gs_leave.

HA_GS_NOT_OK

An error occurred.

This error number is returned synchronously.

HA_GS_NOT_SUPPORTED

The requested function is not currently supported.

This error number is returned synchronously.

HA_GS_OK

The subroutine was successful.

This return code is returned synchronously.

HA_GS_SOCK_CREATE_FAILED

The Group Services subsystem could not create a socket for communication.

This error number is returned synchronously.

HA_GS_SOCK_INIT_FAILED

The Group Services subsystem could not initialize the socket for communication.

This error number is returned synchronously.

HA_GS_UNKNOWN_GROUP

The group that was specified on the call to the ha_gs_subscribe subroutine does not exist.

This error number is returned asynchronously through the delayed error callback routine.

HA_GS_UNKNOWN_PROVIDER

At least one of the providers that was specified in an expel protocol is not a member of the specified group.

This error number can be returned either synchronously or asynchronously, depending on when the error was detected. This error number is returned in response to the protocol requests resulting from calls to the ha_gs_expel subroutine.

HA_GS_VOTE_NOT_EXPECTED

A vote was received that was not expected. Either no protocol was in progress, or the Group Services subsystem already received a vote for this protocol.

This error number is returned synchronously.

HA_GS_NULL_ADAPTER_INFO

Group Services does not yet have the information about the network adapters.

HA_GS_ADAPTER_INFO_NOT_FOUND

The given adapter is not found in the current adapter table.

HA_GS_ADAPTER_INFO_NOT_SENT

For internal use.

Related Information

GSAPI subroutines: ha_gs_change_state_value, ha_gs_dispatch, ha_gs_expel, ha_gs_init, ha_gs_join, ha_gs_leave, ha_gs_quit, ha_gs_send_message, ha_gs_subscribe, ha_gs_unsubscribe, ha_gs_vote, ha_gs_change_attributes, ha_gs_goodbye

GSAPI header file: ha_gs.h