FLUSH SPREAD

Error Return Codes

Flush Spread uses the same error return codes as Spread. In addition to these common error codes, Flush Spread also adds the following error codes:
#define		ILLEGAL_PARAM
#define		WOULD_BLOCK
#define		ILLEGAL_MESSAGE_TYPE
#define		ILLEGAL_STATE
#define		ILLEGAL_RECEIVERS
  1. ILLEGAL_PARAM:

    An illegal parameter was passed to a call. Usually this is the result of specifying a negative array size.

  2. WOULD_BLOCK:

    A receive call that requested the DONT_BLOCK service would have blocked.

  3. ILLEGAL_MESSAGE_TYPE:

    A multicast call was made with an illegal message type.

  4. ILLEGAL_STATE:

    A FL_multicast or FL_flush call was made on a group while that group was in a prohibited state for that call.

  5. ILLEGAL_RECEIVERS:

    A subgroup-multicast or unicast call specified receivers that were not currently members of the reference group.

Flush Spread also expands the meaning of the following Spread error codes:
#define		ILLEGAL_GROUP
#define		ILLEGAL_MESSAGE
  1. ILLEGAL_GROUP:

    In addition to representing illegal Spread group names, this error also represents that a group-specific call (i.e. - multicast, flush, join, leave) was made illegally while either not a member of the group (multicast, flush, leave) or while a member of the group (join).

  2. ILLEGAL_MESSAGE:

    This error code in Flush Spread has the same meaning as it does in Spread. It means that either a send or receive message buffer or scatter was illegal in some manner. This can be returned if the size of a buffer is negative or if the number of scat elements is illegal (negative or greater than FL_MAX_SCATTER_ELEMENTS).