PrevUpHomeFlux Reference Manual

flux-envoy

flux-envoy —

Synopsis




#define     FLUX_ENVOY                      (envoy)
struct      FluxEnvoy;
struct      FluxEnvoyDequeuer;
void        flux_envoy_init                 (FluxEnvoy *envoy,
                                             FluxIO *io);
FluxEnvoy*  flux_envoy_new                  (FluxIO *io);
void        flux_envoy_finalize             (FluxObject *obj);
guint       flux_envoy_add_dequeuer_before  (FluxEnvoy *envoy,
                                             const gchar *token,
                                             FluxEnvoyDequeueFunc *func,
                                             gpointer data);
guint       flux_envoy_add_dequeuer_after   (FluxEnvoy *envoy,
                                             const gchar *token,
                                             FluxEnvoyDequeueFunc *func,
                                             gpointer data);
void        flux_envoy_add_dequeuer_list_before
                                            (FluxEnvoy *envoy,
                                             FluxEnvoyDequeuer *dequeuers,
                                             gpointer data);
void        flux_envoy_add_dequeuer_list_after
                                            (FluxEnvoy *envoy,
                                             FluxEnvoyDequeuer *dequeuers,
                                             gpointer data);
void        flux_envoy_remove_dequeuer_by_id
                                            (FluxEnvoy *envoy,
                                             guint id);
void        flux_envoy_remove_dequeuers_by_token
                                            (FluxEnvoy *envoy,
                                             const gchar *token);
void        flux_envoy_remove_dequeuers_by_func
                                            (FluxEnvoy *envoy,
                                             FluxEnvoyDequeueFunc *func);
void        flux_envoy_remove_dequeuers_by_data
                                            (FluxEnvoy *envoy,
                                             gpointer data);
void        flux_envoy_remove_dequeuers_by_token_and_func
                                            (FluxEnvoy *envoy,
                                             const gchar *token,
                                             FluxEnvoyDequeueFunc *func);
void        flux_envoy_remove_dequeuer_by_all
                                            (FluxEnvoy *envoy,
                                             const gchar *token,
                                             FluxEnvoyDequeueFunc *func,
                                             gpointer data);
void        flux_envoy_remove_dequeuer_list (FluxEnvoy *envoy,
                                             FluxEnvoyDequeuer *dequeuers);

Description

Details

FLUX_ENVOY()

#define FLUX_ENVOY(envoy) ((FluxEnvoy *) envoy)

envoy :

struct FluxEnvoy

struct FluxEnvoy {

  FluxComm comm;

  GList *assoc_list;
  guint next_id;
};

struct FluxEnvoyDequeuer

struct FluxEnvoyDequeuer {

  const gchar *token;
  FluxEnvoyDequeueFunc *func;
};

flux_envoy_init ()

void        flux_envoy_init                 (FluxEnvoy *envoy,
                                             FluxIO *io);

envoy :
io :

flux_envoy_new ()

FluxEnvoy*  flux_envoy_new                  (FluxIO *io);

io :
Returns :

flux_envoy_finalize ()

void        flux_envoy_finalize             (FluxObject *obj);

obj :

flux_envoy_add_dequeuer_before ()

guint       flux_envoy_add_dequeuer_before  (FluxEnvoy *envoy,
                                             const gchar *token,
                                             FluxEnvoyDequeueFunc *func,
                                             gpointer data);

envoy :
token :
func :
data :
Returns :

flux_envoy_add_dequeuer_after ()

guint       flux_envoy_add_dequeuer_after   (FluxEnvoy *envoy,
                                             const gchar *token,
                                             FluxEnvoyDequeueFunc *func,
                                             gpointer data);

envoy :
token :
func :
data :
Returns :

flux_envoy_add_dequeuer_list_before ()

void        flux_envoy_add_dequeuer_list_before
                                            (FluxEnvoy *envoy,
                                             FluxEnvoyDequeuer *dequeuers,
                                             gpointer data);

envoy :
dequeuers :
data :

flux_envoy_add_dequeuer_list_after ()

void        flux_envoy_add_dequeuer_list_after
                                            (FluxEnvoy *envoy,
                                             FluxEnvoyDequeuer *dequeuers,
                                             gpointer data);

envoy :
dequeuers :
data :

flux_envoy_remove_dequeuer_by_id ()

void        flux_envoy_remove_dequeuer_by_id
                                            (FluxEnvoy *envoy,
                                             guint id);

envoy :
id :

flux_envoy_remove_dequeuers_by_token ()

void        flux_envoy_remove_dequeuers_by_token
                                            (FluxEnvoy *envoy,
                                             const gchar *token);

envoy :
token :

flux_envoy_remove_dequeuers_by_func ()

void        flux_envoy_remove_dequeuers_by_func
                                            (FluxEnvoy *envoy,
                                             FluxEnvoyDequeueFunc *func);

envoy :
func :

flux_envoy_remove_dequeuers_by_data ()

void        flux_envoy_remove_dequeuers_by_data
                                            (FluxEnvoy *envoy,
                                             gpointer data);

envoy :
data :

flux_envoy_remove_dequeuers_by_token_and_func ()

void        flux_envoy_remove_dequeuers_by_token_and_func
                                            (FluxEnvoy *envoy,
                                             const gchar *token,
                                             FluxEnvoyDequeueFunc *func);

envoy :
token :
func :

flux_envoy_remove_dequeuer_by_all ()

void        flux_envoy_remove_dequeuer_by_all
                                            (FluxEnvoy *envoy,
                                             const gchar *token,
                                             FluxEnvoyDequeueFunc *func,
                                             gpointer data);

envoy :
token :
func :
data :

flux_envoy_remove_dequeuer_list ()

void        flux_envoy_remove_dequeuer_list (FluxEnvoy *envoy,
                                             FluxEnvoyDequeuer *dequeuers);

envoy :
dequeuers :
<< flux-comm