Main Page | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

mwService Struct Reference

#include <mw_service.h>


Detailed Description

A service is the recipient of sendOnCnl messages sent over channels marked with the corresponding service id.

Services provide functionality such as IM relaying, Awareness tracking and notification, and Conference handling. It is a service's responsibility to accept or destroy channels, and to process data sent over those channels


Data Fields

guint32 type
 the unique identifier by which this service is registered.

enum mwServiceState state
 the state of this service.

mwSessionsession
 session this service is attached to.

mwService_funcGetName get_name
mwService_funcGetDesc get_desc
mwService_funcRecvCreate recv_create
 The service's channel create handler.

mwService_funcRecvAccept recv_accept
 The service's channel accept handler.

mwService_funcRecvDestroy recv_destroy
 The service's channel destroy handler.

mwService_funcRecv recv
 The service's input handler.

mwService_funcStart start
 The service's start handler.

mwService_funcStop stop
 The service's stop handler.

mwService_funcClear clear
 The service's cleanup handler.

gpointer client_data
 Optional client data, not for use by service implementations.

GDestroyNotify client_cleanup
 Optional client data cleanup function.


Field Documentation

mwService_funcClear mwService::clear
 

The service's cleanup handler.

Service implementations should presume that mwService::stop will be called first. The clear handler is not for shutting down channels or generating non-cleanup side-effects, it is only for handling tear-down of the service, and will only be called once for any instance.

GDestroyNotify mwService::client_cleanup
 

Optional client data cleanup function.

Called with client_data from mwService_free

gpointer mwService::client_data
 

Optional client data, not for use by service implementations.

mwService_funcGetDesc mwService::get_desc
 

Returns:
string short description of the service

mwService_funcGetName mwService::get_name
 

Returns:
string short name of the service

mwService_funcRecv mwService::recv
 

The service's input handler.

Called when the session receives data on a channel belonging to this service

mwService_funcRecvAccept mwService::recv_accept
 

The service's channel accept handler.

Called when the session receives a channel accept message for a channel with a service matching this service's type.

mwService_funcRecvCreate mwService::recv_create
 

The service's channel create handler.

Called when the session receives a channel create message with a service matching this service's type.

mwService_funcRecvDestroy mwService::recv_destroy
 

The service's channel destroy handler.

Called when the session receives a channel destroy message for a channel with a service matching this service's type.

struct mwSession* mwService::session
 

session this service is attached to.

mwService_funcStart mwService::start
 

The service's start handler.

Called upon the receipt of a service available message.

enum mwServiceState mwService::state
 

the state of this service.

Determines whether or not the session should call the start function upon receipt of a service available message. Should not be set or checked by hand.

mwService_funcStop mwService::stop
 

The service's stop handler.

Called when the session is shutting down, or when the service is free'd.

guint32 mwService::type
 

the unique identifier by which this service is registered.

The type value also relates to those channels which will be directed to this service


The documentation for this struct was generated from the following file:
Generated on Sun Nov 27 16:57:20 2005 for meanwhile by doxygen 1.3.5