[an error occurred while processing this directive] Documentation for cluster_transition() [an error occurred while processing this directive]

[an error occurred while processing this directive] CI Project Overview License Download CVS Contributed Code Mailing Lists Goals Project List Features CLMS Features ICS Features Current Status Kernel Hooks Limitations / Enhancements CI Documentation Kernel Patch Cluster Tools [an error occurred while processing this directive] Printer-friendly version

Manpage of LIBCLUSTER

LIBCLUSTER

Section: OpenSSI Prog Manual (3ssi)
Updated: 27 October 2003

NAME

clusternode_transition - returns information about the next cluster membership transition involving any node going to or coming from the CLUSTERNODE_UP state

SYNOPSIS

#include <sys/cluster.h>

int cluster_transition(transid_t *transid,
                       int sizeof(cluster_transinfo_t),
                       cluster_transinfo_t *transinfo);

cc [flag ...] file -lcluster [library ...]

DESCRIPTION

Returns the next simple membership transition that occurred after the transid value passed in. Part of the return value is an indication of which cluster node was involved in the transition. A simple transition means a transition to or from the CLUSTERNODE_UP state. Node state transitions from not UP to UP and from UP to not UP satisfy the requirements of a simple node state model. Based on the formal states described in the cluster(8ssi) manual page, the simple transition is from any state to CLUSTERNODE_UP or CLUSTERNODE_UP to any other state. To see all the state transitions, use the cluster(8ssi) manual page.

For an application to be signaled when a cluster membership transition has occurred, the SIGCLUSTER signal must be enabled (see cluster(8ssi) and signal(2)). Note that being signaled can mean 0, 1, or more simple transitions have occurred since the last time SIGCLUSTER was processed.

PARAMETERS

transid: A pointer to both an input and output parameter. As an input parameter, it is obtained from an earlier call to cluster_membership(3ssi) or cluster_transition(3ssi). As an input parameter, it indicates where in the history of membership transitions to look for the next transition. As a return parameter, it returns the membership transition ID of the transition returned in the transinfo parameter.
transinfo: A pointer to a cluster_transinfo structure in which is returned the cluster membership transition information for the next transition.

RETURN VALUE

-1: Indicates failure, and errno is set to indicate the cause of the error. Neither the membership transition ID nor the contents of transinfo are modified.
0: Indicates no transitions have occurred since the transition specified by transid. Neither the membership transition ID nor the contents of transinfo are modified.
1: Indicates success. A transition has occurred since the transition specified by transid, and the contents of transinfo reflect that transition. The transition ID has also been updated.

ERRORS

If the call to cluster_transition fails, errno is set to the following value to indicate the cause of the error:

EINVAL: The transid or transinfo pointer was invalid or the transition ID was invalid.