mama/ft.h

Types

Functions

Types Documentation

enum mamaFtState_

The enumeration of fault tolerant states

enum mamaFtType_

The enumeration of fault tolerant types

typedef mamaFtState

typedef enum mamaFtState_ mamaFtState;

The enumeration of fault tolerant states

typedef mamaFtType

typedef enum mamaFtType_ mamaFtType;

The enumeration of fault tolerant types

typedef mamaFtMember

typedef void* mamaFtMember;

typedef mamaFtMemberOnFtStateChangeCb

typedef void( MAMACALLTYPE * mamaFtMemberOnFtStateChangeCb) (mamaFtMember ftMember, const char *groupName, mamaFtState state, void *closure);

Callback function type for MAMA fault tolerant state change events.

Parameters:

• ftMember The mamaFtMember to which the callback event applies
• groupName The group name of the mamaFtMember for which the fault tolerant event applies
• mamaFtState The new fault tolerant state for the group member
• closure The closure passed to the mamaFtMember when mamaFtMember_setup() is called

Functions Documentation

function mamaFtMember_create

MAMAExpDLL mama_status mamaFtMember_create(
    mamaFtMember * member
)

Allocate a MAMA fault tolerance group member. This function is typically followed by mamaFtMember_setup() and mamaFtMember_activate().

Parameters:

• member A pointer to a mamaFtMember. When the function is called successfully the ftMember will be a pointer to a block of allocated memory.

Return: mama_status return code can be one of: MAMA_STATUS_NOMEM MAMA_STATUS_OK

function mamaFtMember_setup

MAMAExpDLL mama_status mamaFtMember_setup(
    mamaFtMember member,
    mamaFtType fttype,
    mamaQueue eventQueue,
    mamaFtMemberOnFtStateChangeCb callback,
    mamaTransport transport,
    const char * groupName,
    mama_u32_t weight,
    mama_f64_t heartbeatInterval,
    mama_f64_t timeoutInterval,
    void * closure
)

Set up a MAMA fault tolerance group member. This is only an initialization function. In order to actually start the fault tolerance monitoring, use mamaFtMember_activate().

Parameters:

• member The mamaFtMember to be initialized
• fttype The type of fault tolerance to be used for the member
• eventQueue The queue on which the mamaFtMember sends and receives heartbeats
• transport The mamaTransport used for sending and receiving heartbeats
• groupName The group name for the mamaFtMember
• weight The initial weight of the mamaFtMember
• heartbeatInterval The time in seconds between sending heartbeats
• timeoutInterval The time in seconds that a mamaFtMember in state MAMA_FT_STATE_STANBY or MAMA_FT_STATE_UNKNOWN will wait to receive a heartbeat before changing state to MAMA_FT_STATE_ACTIVE
• closure The closure will be passed to subsequent callback invocations for thie mamaFtMember

Return: mama_status MAMA_STATUS_OK will be returned on success, otherwise a mama_status code indicating failure will be returned

function mamaFtMember_destroy

MAMAExpDLL mama_status mamaFtMember_destroy(
    mamaFtMember member
)

Destroy a MAMA fault tolerance group member.

Parameters:

• member The mamaFtMember. When the function returns, memory previously allocated for the member will have been freed

Return: mama_status return code can be one of: MAMA_STATUS_INVALID_ARG MAMA_STATUS_OK

function mamaFtMember_activate

MAMAExpDLL mama_status mamaFtMember_activate(
    mamaFtMember member
)

Activate the MAMA fault tolerance group member. The member will begin to send and receive heartbeats. If the member is already active, this function call will deactivate it.

Parameters:

• member The mamaFtMember

Return: mama_status MAMA_STATUS_OK will be returned on success, otherwuse a mama_status code indicating failure will be returned

function mamaFtMember_deactivate

MAMAExpDLL mama_status mamaFtMember_deactivate(
    mamaFtMember member
)

Deactivate the MAMA fault tolerance group member. The member will stop sending and listening for heartbeats.

Parameters:

• member the mamaFtMember

Return: mama_status return code can be one of: MAMA_STATUS_INVALID_ARG MAAM_STATUS_OK

function mamaFtMember_isActive

MAMAExpDLL mama_status mamaFtMember_isActive(
    const mamaFtMember member,
    int * result
)

Get whether the MAMA fault tolerance member is actively running (not related to its state). Use mamaFtMember_getState() to determine the actual state of the member.

Parameters:

• member The mamaFtMember
• result This will be set to 1 if the member is currently active, 0 if it is not

Return: mama_status return code can be one of: MAMA_STATUS_INVALID_ARG MAMA_STATUS_OK

function mamaFtMember_getGroupName

MAMAExpDLL mama_status mamaFtMember_getGroupName(
    const mamaFtMember member,
    const char ** result
)

Get the name of the group to which this MAMA FT member belongs.

Parameters:

• member The mamaFtMember
• result When the function is called successfully, this will point to the member’s group name

Return: mama_status return code can be on of: MAMA_STATUS_INVALID_ARG MAMA_STATUS_OK

function mamaFtMember_getWeight

MAMAExpDLL mama_status mamaFtMember_getWeight(
    const mamaFtMember member,
    mama_u32_t * result
)

Get the fault tolerance weight of the MAMA FT member.

Parameters:

• member The mamaFtMember
• result When the function is called successfully, this will store the value of the member’s weight

Return: mama_status return code can be one of: MAMA_STATUS_INVALID_ARG MAMA_STATUS_OK

function mamaFtMember_getHeartbeatInterval

MAMAExpDLL mama_status mamaFtMember_getHeartbeatInterval(
    const mamaFtMember member,
    mama_f64_t * result
)

Get the fault tolerance heartbeat interval of the MAMA FT member.

Parameters:

• member The mamaFtMember
• result When the function is called successfully, this will store the value of the member’s heartbeat interval

Return: mama_status return code can be one of: MAMA_STATUS_INVALID_ARG MAMA_STATUS_OK

function mamaFtMember_getTimeoutInterval

MAMAExpDLL mama_status mamaFtMember_getTimeoutInterval(
    const mamaFtMember member,
    mama_f64_t * result
)

Get the fault tolerance timeout interval of the MAMA FT member.

Parameters:

• member The mamaFtMember
• result When the function is called successfully, this will store the value of the member’s timeout interval

Return: mama_status return code can be one of: MAMA_STATUS_INVALID_ARG MAMA_STATUS_OK

function mamaFtMember_getHeartbeatTick

MAMAExpDLL mama_status mamaFtMember_getHeartbeatTick(
    const mamaFtMember member,
    mama_u32_t * result
)

Get the current heartbeat tick of the MAMA FT member.

function mamaFtMember_getClosure

MAMAExpDLL mama_status mamaFtMember_getClosure(
    const mamaFtMember member,
    void ** result
)

Get the closure argument (provided in the mamaFtMember_setup() function) of the MAMA FT member.

Parameters:

• member The mamaFtMember
• result When the function is called successfully, this will point to member’s closure

Return: mama_status return code can be one of: MAMA_STATUS_INVALID_ARG MAMA_STATUS_OK

function mamaFtMember_setWeight

MAMAExpDLL mama_status mamaFtMember_setWeight(
    mamaFtMember member,
    mama_u32_t value
)

Set the fault tolerance weight of the MAMA FT member. The FT weight can be changed dynamically, if desired. The member with the highest weight will become the active member.

Parameters:

• member The mamaFtMember
• value The new fault tolerance weight

Return: mama_status return code can be one of: MAMA_STATUS_INVALID_ARG MAMA_STATUS_OK

function mamaFtMember_setInstanceId

MAMAExpDLL mama_status mamaFtMember_setInstanceId(
    mamaFtMember member,
    const char * id
)

Set the instance ID of the MAMA FT member. The instance ID is used to uniquely identify members of a fault tolerant group.

Parameters:

• member The mamaFtMember
• The new instance ID. This string is copied by the function

Return: mama_status return code can be one of: MAMA_STATUS_INVALID_ARG MAMA_STATUS_NOMEM MAMA_STATUS_OK

Most applications should allow the MAMA API to automatically set the instance ID and this function would not be called. If not set explicitly before activation, then the instance ID is automatically set according to the following format: {group-name}.{hex-ip-addr}.{hex-pid}. For example, if the group name is “FOO”, the IP address is 192.168.187.9, and the PId is 10777, the default instance ID would be: FOO.c0a8bb9.2a19

function mamaFtStateToString

MAMAExpDLL const char * mamaFtStateToString(
    mamaFtState state
)

Convert a fault tolerant state to a string.

Parameters:

• state The state to convert.

Return: const char* A string representation of the state. This will be either “standby”, “active”, “unknown”, or “error” in the case where the current state is unrecognised

Source code

/* $Id$
 *
 * OpenMAMA: The open middleware agnostic messaging API
 * Copyright (C) 2011 NYSE Technologies, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#ifndef MamaFtH__
#define MamaFtH__

#include <mama/mama.h>

#if defined(__cplusplus)
extern "C" {
#endif

typedef enum mamaFtState_
{
    MAMA_FT_STATE_STANDBY  = 0, 
    MAMA_FT_STATE_ACTIVE   = 1, 
    MAMA_FT_STATE_UNKNOWN  = 99 
} mamaFtState;

typedef enum mamaFtType_
{
    MAMA_FT_TYPE_MULTICAST = 1, 
    MAMA_FT_TYPE_BRIDGE    = 2, 
    MAMA_FT_TYPE_MAX       = 3 
} mamaFtType;

typedef void* mamaFtMember;


typedef void (
MAMACALLTYPE
*mamaFtMemberOnFtStateChangeCb) (mamaFtMember  ftMember,
                                               const char*   groupName,
                                               mamaFtState   state,
                                               void*         closure);

MAMAExpDLL
extern mama_status
mamaFtMember_create (
    mamaFtMember*  member);

MAMAExpDLL
extern mama_status
mamaFtMember_setup (
    mamaFtMember                   member,
    mamaFtType                     fttype,
    mamaQueue                      eventQueue,
    mamaFtMemberOnFtStateChangeCb  callback,
    mamaTransport                  transport,
    const char*                    groupName,
    mama_u32_t                     weight,
    mama_f64_t                     heartbeatInterval,
    mama_f64_t                     timeoutInterval,
    void*                          closure);

MAMAExpDLL
extern mama_status
mamaFtMember_destroy (
    mamaFtMember    member);

MAMAExpDLL
extern mama_status
mamaFtMember_activate (
    mamaFtMember    member);

MAMAExpDLL
extern mama_status
mamaFtMember_deactivate (
    mamaFtMember    member);

MAMAExpDLL
extern mama_status
mamaFtMember_isActive (
    const mamaFtMember  member,
    int*                result);

MAMAExpDLL
extern mama_status
mamaFtMember_getGroupName (
    const mamaFtMember  member,
    const char**        result);

MAMAExpDLL
extern mama_status
mamaFtMember_getWeight (
    const mamaFtMember  member,
    mama_u32_t*         result);

MAMAExpDLL
extern mama_status
mamaFtMember_getHeartbeatInterval (
    const mamaFtMember  member,
    mama_f64_t*         result);

MAMAExpDLL
extern mama_status
mamaFtMember_getTimeoutInterval (
    const mamaFtMember  member,
    mama_f64_t*         result);

MAMAExpDLL
extern mama_status
mamaFtMember_getHeartbeatTick (
    const mamaFtMember  member,
    mama_u32_t*         result);

MAMAExpDLL
extern mama_status
mamaFtMember_getClosure (
    const mamaFtMember  member,
    void**              result);

MAMAExpDLL
extern mama_status
mamaFtMember_setWeight (
    mamaFtMember  member,
    mama_u32_t    value);

MAMAExpDLL
extern mama_status
mamaFtMember_setInstanceId (
    mamaFtMember  member,
    const char*   id);

MAMAExpDLL
extern const char*
mamaFtStateToString (mamaFtState state);


#if defined(__cplusplus)
}
#endif

#endif /* MamaFtH  __ */

Updated on 2023-03-31 at 15:29:16 +0100