[an error occurred while processing this directive] Documentation for cluster_detailedtransition() [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: 30 October 2003

NAME

cluster_detailedtransition - returns detailed transition information

SYNOPSIS

#include <sys/cluster.h>

int cluster_detailedtransition(int which,
    transid_t *transid, int sizeof(cluster_transinfo_t),
    cluster_transinfo_t *transinfo)

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

DESCRIPTION

This function returns details about a state transition relative to the specified transition ID. Based on the relative transition which and the transition ID transid supplied, this function fills a transition information structure with the transition ID, the time of the transition, the node number, the state from and to which the node transitioned, and the cause of the transition.

This information can be returned for the transition specified by transid , the transition following the one specified by transid , the transition previous, and the first and last transitions that have occurred in the cluster.

This function is the detailed transition call because it returns any state transition any cluster node makes (a cluster node can be in one of eight states). For a more simple transition history interface, see cluster_transition(3ssi).

For details about node states and transitions, see 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(4)). Note that being signaled can mean 0, 1 or more simple transitions have occurred since the last time SIGCLUSTER was processed.

The parameter which specifies a transition relative to the transid. This value can be one of :

CLUSTER_TRANSWHICH_THIS: Transition specified by transid
CLUSTER_TRANSWHICH_NEXT: Transition following the one specified by transid
CLUSTER_TRANSWHICH_PREVIOUS: Transition preceding the one specified by transid.
CLUSTER_TRANSWHICH_FIRST: The first transition that occurred in the cluster. With this value, transid is ignored on input but is filled in on output. Using FIRST followed by a series of NEXT calls, you can obtain the complete cluster membership transition history since the last cluster-wide boot.
CLUSTER_TRANSWHICH_LAST: The most current transition the cluster went through. With this value, transid is ignored as an input parameter but returns the transition ID of the last transition.
The parameter transid is a pointer to a transition ID obtained from a previous call to cluster_membership(3ssi), cluster_transition(3ssi), or cluster_detailedtransition(3ssi).
The parameter transinfo is a pointer to a structure of type cluster_transinfo_t.

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