OpenMAMA
clientmanage.h File Reference

Go to the source code of this file.

Data Structures

struct  mamaCommand
 

Macros

#define MAMA_CM_TOPIC   "__MAMA_CM"
 FIDS and Command IDs for client management commands. More...
 
#define MAMA_CM_PUB_TOPIC   "__MAMA_PUB_CM"
 
#define MAMA_SYNC_TOPICS_ID   101
 The SyncResponder puts the topics in a string array with this ID. More...
 
#define MAMA_CM_COMMAND_ID   102
 Future: We may add other (possibly wadmin style) commands U16. More...
 
#define MAMA_SYNC_SOURCE_ID   103
 Client only sends topics for this SOURCE. More...
 
#define MAMA_SYNC_TOPICS_PER_MSG_ID   104
 Client responds with max TOPICS_PER_MSG U16. More...
 
#define MAMA_SYNC_RESPONSE_DELAY_ID   105
 Clients waits random interval > 0 < RESPONSE_DELAY before initiating response. More...
 
#define MAMA_SYNC_RESPONSE_DURATION_ID   106
 Clients send response over this duration. More...
 
#define MAMA_SYNC_TYPES_ID   107
 The SyncResponder puts the subscription types in a string array with this ID. More...
 

Typedefs

typedef void(* cmCommandDtor) (void *handle)
 This structure allows for generic commands to be destroyed by the clientmanageresponder. More...
 
typedef void(* mamaCommandEndCB) (mamaCommand *command, void *closure)
 Commands invoke this callback when they complete so the responder can destroy them. More...
 

Enumerations

enum  mamaCmCommand { MAMA_COMMAND_SYNC = 1 }
 Commands. More...
 

Macro Definition Documentation

◆ MAMA_CM_TOPIC

#define MAMA_CM_TOPIC   "__MAMA_CM"

FIDS and Command IDs for client management commands.

FIDS Client Management Request Get Sent HERE

◆ MAMA_CM_PUB_TOPIC

#define MAMA_CM_PUB_TOPIC   "__MAMA_PUB_CM"

◆ MAMA_SYNC_TOPICS_ID

#define MAMA_SYNC_TOPICS_ID   101

The SyncResponder puts the topics in a string array with this ID.

◆ MAMA_CM_COMMAND_ID

#define MAMA_CM_COMMAND_ID   102

Future: We may add other (possibly wadmin style) commands U16.

◆ MAMA_SYNC_SOURCE_ID

#define MAMA_SYNC_SOURCE_ID   103

Client only sends topics for this SOURCE.

◆ MAMA_SYNC_TOPICS_PER_MSG_ID

#define MAMA_SYNC_TOPICS_PER_MSG_ID   104

Client responds with max TOPICS_PER_MSG U16.

◆ MAMA_SYNC_RESPONSE_DELAY_ID

#define MAMA_SYNC_RESPONSE_DELAY_ID   105

Clients waits random interval > 0 < RESPONSE_DELAY before initiating response.

◆ MAMA_SYNC_RESPONSE_DURATION_ID

#define MAMA_SYNC_RESPONSE_DURATION_ID   106

Clients send response over this duration.

◆ MAMA_SYNC_TYPES_ID

#define MAMA_SYNC_TYPES_ID   107

The SyncResponder puts the subscription types in a string array with this ID.

Typedef Documentation

◆ cmCommandDtor

typedef void(* cmCommandDtor) (void *handle)

This structure allows for generic commands to be destroyed by the clientmanageresponder.

It contains a handle and a pointer to a destructor function.

It is not correct for the commands to destroy themselves on completion since the responder creates them. Furthermore, there would be problems at shutdown.

Every command needs to populate this structure accordingly.

◆ mamaCommandEndCB

typedef void(* mamaCommandEndCB) (mamaCommand *command, void *closure)

Commands invoke this callback when they complete so the responder can destroy them.

Enumeration Type Documentation

◆ mamaCmCommand

Commands.

Enumerator
MAMA_COMMAND_SYNC 

Sync Request.

65 {
MAMA_COMMAND_SYNC
@ MAMA_COMMAND_SYNC
Sync Request.
Definition: clientmanage.h:67
mamaCmCommand
mamaCmCommand
Commands.
Definition: clientmanage.h:64


© 2012 Linux Foundation