#include <mw_service.h>
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. | |
Related Functions | |
(Note that these are not member functions.) | |
mwService_funcClear | clear |
The service's cleanup handler. | |
GDestroyNotify | client_cleanup |
Optional client data cleanup function. | |
gpointer | client_data |
Optional client data, not for use by service implementations. | |
mwService_funcGetDesc | get_desc |
mwService_funcGetName | get_name |
mwService_funcRecv | recv |
The service's input handler. | |
mwService_funcRecvAccept | recv_accept |
The service's channel accept handler. | |
mwService_funcRecvCreate | recv_create |
The service's channel create handler. | |
mwService_funcRecvDestroy | recv_destroy |
The service's channel destroy handler. | |
mwSession * | session |
session this service is attached to. | |
mwService_funcStart | start |
The service's start handler. | |
enum mwServiceState | state |
the state of this service. | |
mwService_funcStop | stop |
The service's stop handler. |
|
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. |
|
Optional client data cleanup function. Called with client_data from mwService_free |
|
Optional client data, not for use by service implementations.
|
|
|
|
|
|
The service's input handler. Called when the session receives data on a channel belonging to this service |
|
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. |
|
The service's channel create handler. Called when the session receives a channel create message with a service matching this service's type. |
|
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. |
|
session this service is attached to.
|
|
The service's start handler. Called upon the receipt of a service available message. |
|
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. |
|
The service's stop handler. Called when the session is shutting down, or when the service is free'd. |
|
the unique identifier by which this service is registered. The type value also relates to those channels which will be directed to this service |