FLUSH SPREAD

FL_join

Section: User Manuals (3)
Updated: Dec 2000

NAME

FL_join - join a connection to a Flush Spread group

SYNOPSIS

#include <fl.h>

int FL_join(mailbox mbox, const char *group_name);

DESCRIPTION

FL_join joins the connection represented by mbox to a group with the name group_name. If the group does not exist among the Spread daemons it is created, otherwise the connection is joined to the existing group. A connection may not join a group it is already a member of, which it has already joined, or from which it is currently leaving.

RETURN VALUES

Returns 0 on success or one of the following errors ( < 0 ):
ILLEGAL_GROUP
The group_name given to join was illegal for some reason, usually because it was of length 0 or length > MAX_GROUP_NAME. This error is also returned if a group with which this connection is already involved (i.e. - already joining, already joined, currently leaving) is joined again.

ILLEGAL_SESSION
The connection represented by mbox is illegal, usually because it is not active.

CONNECTION_CLOSED
Errors occurred during communication and the join could not be initiated.

AUTHOR

John Schultz <jschultz@cnds.jhu.edu>