jabberd2  2.3.6
Data Fields
module_st Struct Reference

data for a single module More...

#include <sm.h>

Data Fields

mm_t mm
 module manager More...
 
const char * name
 name of module More...
 
int index
 module index. More...
 
void * handle
 module handle More...
 
int(* module_init_fn )(mod_instance_t)
 module init function More...
 
int init
 number of times the module intialiser has been called More...
 
void * private
 module private data More...
 
int(* sess_start )(mod_instance_t mi, sess_t sess)
 sess-start handler More...
 
void(* sess_end )(mod_instance_t mi, sess_t sess)
 sess-end handler More...
 
mod_ret_t(* in_sess )(mod_instance_t mi, sess_t sess, pkt_t pkt)
 in-sess handler More...
 
mod_ret_t(* in_router )(mod_instance_t mi, pkt_t pkt)
 in-router handler More...
 
mod_ret_t(* out_sess )(mod_instance_t mi, sess_t sess, pkt_t pkt)
 out-sess handler More...
 
mod_ret_t(* out_router )(mod_instance_t mi, pkt_t pkt)
 out-router handler More...
 
mod_ret_t(* pkt_sm )(mod_instance_t mi, pkt_t pkt)
 pkt-sm handler More...
 
mod_ret_t(* pkt_user )(mod_instance_t mi, user_t user, pkt_t pkt)
 pkt-user handler More...
 
mod_ret_t(* pkt_router )(mod_instance_t mi, pkt_t pkt)
 pkt-router handler More...
 
int(* user_load )(mod_instance_t mi, user_t user)
 user-load handler More...
 
int(* user_unload )(mod_instance_t mi, user_t user)
 user-load handler More...
 
int(* user_create )(mod_instance_t mi, jid_t jid)
 user-create handler More...
 
void(* user_delete )(mod_instance_t mi, jid_t jid)
 user-delete handler More...
 
void(* disco_extend )(mod_instance_t mi, pkt_t pkt)
 disco-extend handler More...
 
void(* free )(module_t mod)
 called when module is freed More...
 

Detailed Description

data for a single module

Definition at line 403 of file sm.h.

Field Documentation

mm_t module_st::mm
const char* module_st::name
int module_st::index

module index.

this is the index into user->module_data and sess->module_data where the module can store its own per-user/per-session data

Definition at line 408 of file sm.h.

Referenced by _announce_in_sess(), _iq_private_in_sess(), _privacy_in_router(), _privacy_in_sess(), _privacy_out_router(), _privacy_user_load(), _roster_in_sess(), _roster_pkt_user(), _vacation_in_sess(), _vacation_pkt_user(), _vacation_user_load(), _verify_in_sess(), _verify_user_load(), mm_new(), and module_init().

void* module_st::handle

module handle

Definition at line 412 of file sm.h.

Referenced by _mm_reaper(), and mm_new().

int(* module_st::module_init_fn) (mod_instance_t)

module init function

Definition at line 414 of file sm.h.

Referenced by mm_new().

int module_st::init

number of times the module intialiser has been called

Definition at line 416 of file sm.h.

Referenced by mm_new(), and module_init().

void* module_st::private
int(* module_st::sess_start) (mod_instance_t mi, sess_t sess)

sess-start handler

Definition at line 420 of file sm.h.

Referenced by mm_sess_start(), and module_init().

void(* module_st::sess_end) (mod_instance_t mi, sess_t sess)

sess-end handler

Definition at line 421 of file sm.h.

Referenced by mm_sess_end(), and module_init().

mod_ret_t(* module_st::in_sess) (mod_instance_t mi, sess_t sess, pkt_t pkt)

in-sess handler

Definition at line 423 of file sm.h.

Referenced by mm_in_sess(), and module_init().

mod_ret_t(* module_st::in_router) (mod_instance_t mi, pkt_t pkt)

in-router handler

Definition at line 424 of file sm.h.

Referenced by mm_in_router(), and module_init().

mod_ret_t(* module_st::out_sess) (mod_instance_t mi, sess_t sess, pkt_t pkt)

out-sess handler

Definition at line 426 of file sm.h.

Referenced by mm_out_sess(), and module_init().

mod_ret_t(* module_st::out_router) (mod_instance_t mi, pkt_t pkt)

out-router handler

Definition at line 427 of file sm.h.

Referenced by mm_out_router(), and module_init().

mod_ret_t(* module_st::pkt_sm) (mod_instance_t mi, pkt_t pkt)

pkt-sm handler

Definition at line 429 of file sm.h.

Referenced by mm_pkt_sm(), and module_init().

mod_ret_t(* module_st::pkt_user) (mod_instance_t mi, user_t user, pkt_t pkt)

pkt-user handler

Definition at line 430 of file sm.h.

Referenced by mm_pkt_user(), and module_init().

mod_ret_t(* module_st::pkt_router) (mod_instance_t mi, pkt_t pkt)

pkt-router handler

Definition at line 432 of file sm.h.

Referenced by mm_pkt_router(), and module_init().

int(* module_st::user_load) (mod_instance_t mi, user_t user)

user-load handler

Definition at line 434 of file sm.h.

Referenced by mm_user_load(), and module_init().

int(* module_st::user_unload) (mod_instance_t mi, user_t user)

user-load handler

Definition at line 435 of file sm.h.

Referenced by mm_user_unload().

int(* module_st::user_create) (mod_instance_t mi, jid_t jid)

user-create handler

Definition at line 437 of file sm.h.

Referenced by mm_user_create(), and module_init().

void(* module_st::user_delete) (mod_instance_t mi, jid_t jid)

user-delete handler

Definition at line 438 of file sm.h.

Referenced by mm_user_delete(), and module_init().

void(* module_st::disco_extend) (mod_instance_t mi, pkt_t pkt)

disco-extend handler

Definition at line 440 of file sm.h.

Referenced by mm_disco_extend(), and module_init().

void(* module_st::free) (module_t mod)

called when module is freed

Definition at line 442 of file sm.h.

Referenced by _mm_reaper(), and module_init().


The documentation for this struct was generated from the following file: