Dokumentacja pliku protocol.h

#include "ekg2-config.h"
#include <glib.h>
#include "dynstuff.h"
#include "sessions.h"
#include <stdarg.h>
#include <time.h>
#include <stdlib.h>
#include <sys/types.h>

Wykres zależności załączania dla protocol.h:

Ten wykres pokazuje, które pliki bezpośrednio lub pośrednio załączają ten plik:

Idź do kodu źródłowego tego pliku.

Struktury danych
struct	dcc_s

Definicje
#define	EKG_FORMAT_RGB_MASK   0x00ffffffL /* 0x00BBGGRR */
#define	EKG_FORMAT_R_MASK   0x00ff0000L
#define	EKG_FORMAT_G_MASK   0x0000ff00L
#define	EKG_FORMAT_B_MASK   0x000000ffL
#define	EKG_FORMAT_COLOR   0x01000000L
#define	EKG_FORMAT_BOLD   0x02000000L
#define	EKG_FORMAT_ITALIC   0x04000000L
#define	EKG_FORMAT_UNDERLINE   0x08000000L
#define	EKG_FORMAT_REVERSE   0x10000000L
#define	EKG_NO_THEMEBIT   256
#define	EKG_NO_BEEP   0
#define	EKG_TRY_BEEP   1

Definicje typów
typedef void(*	dcc_close_handler_t) (struct dcc_s *)
typedef struct dcc_s	dcc_t

Wyliczenia
enum	msgack_t {   EKG_ACK_DELIVERED = 0, EKG_ACK_QUEUED, EKG_ACK_DROPPED, EKG_ACK_TEMPFAIL,   EKG_ACK_UNKNOWN, EKG_ACK_MAX }
enum	disconnect_t {   EKG_DISCONNECT_USER = 0, EKG_DISCONNECT_NETWORK, EKG_DISCONNECT_FORCED, EKG_DISCONNECT_FAILURE,   EKG_DISCONNECT_STOPPED }
enum	msgclass_t {   EKG_MSGCLASS_MESSAGE = 0, EKG_MSGCLASS_CHAT, EKG_MSGCLASS_SYSTEM, EKG_MSGCLASS_LOG,   EKG_MSGCLASS_NOT2US = 16, EKG_MSGCLASS_SENT = 32, EKG_MSGCLASS_SENT_CHAT, EKG_MSGCLASS_SENT_LOG,   EKG_MSGCLASS_PRIV_STATUS = 64 }
enum	dcc_type_t { DCC_NONE = 0, DCC_SEND, DCC_GET, DCC_VOICE }

Funkcje
void	protocol_init ()
char *	message_print (const char *session, const char *sender, const char **rcpts, const char *text, const guint32 *format, time_t sent, int mclass, const char *seq, int dobeep, int secure)
int	protocol_connected_emit (const session_t *s)
int	protocol_disconnected_emit (const session_t *s, const char *reason, int type)
int	protocol_message_ack_emit (const session_t *s, const char *rcpt, const char *seq, int status)
int	protocol_message_emit (const session_t *s, const char *uid, char **rcpts, const char *text, const guint32 *format, time_t sent, int mclass, const char *seq, int dobeep, int secure)
int	protocol_status_emit (const session_t *s, const char *uid, int status, char *descr, time_t when)
int	protocol_xstate_emit (const session_t *s, const char *uid, int state, int offstate)
char *	protocol_uid (const char *proto, const char *target)
dcc_t *	dcc_add (session_t *session, const char *uid, dcc_type_t type, void *priv)
int	dcc_close (dcc_t *d)
int	dcc_private_set (dcc_t *, void *)
void *	dcc_private_get (dcc_t *)
int	dcc_close_handler_set (dcc_t *, dcc_close_handler_t)
dcc_close_handler_t	dcc_close_handler_get (dcc_t *)
const char *	dcc_uid_get (dcc_t *)
int	dcc_id_get (dcc_t *)
time_t	dcc_started_get (dcc_t *)
int	dcc_active_set (dcc_t *, int)
int	dcc_active_get (dcc_t *)
int	dcc_offset_set (dcc_t *, int)
int	dcc_offset_get (dcc_t *)
int	dcc_size_set (dcc_t *, int)
int	dcc_size_get (dcc_t *)
int	dcc_filename_set (dcc_t *, const char *)
const char *	dcc_filename_get (dcc_t *)
dcc_type_t	dcc_type_get (dcc_t *)

Zmienne
dcc_t *	dccs

Dokumentacja definicji

EKG_FORMAT_B_MASK

#define EKG_FORMAT_B_MASK   0x000000ffL

EKG_FORMAT_BOLD

#define EKG_FORMAT_BOLD   0x02000000L

EKG_FORMAT_COLOR

#define EKG_FORMAT_COLOR   0x01000000L

EKG_FORMAT_G_MASK

#define EKG_FORMAT_G_MASK   0x0000ff00L

EKG_FORMAT_ITALIC

#define EKG_FORMAT_ITALIC   0x04000000L

EKG_FORMAT_R_MASK

#define EKG_FORMAT_R_MASK   0x00ff0000L

EKG_FORMAT_REVERSE

#define EKG_FORMAT_REVERSE   0x10000000L

EKG_FORMAT_RGB_MASK

#define EKG_FORMAT_RGB_MASK   0x00ffffffL /* 0x00BBGGRR */

EKG_FORMAT_UNDERLINE

#define EKG_FORMAT_UNDERLINE   0x08000000L

EKG_NO_BEEP

#define EKG_NO_BEEP   0

EKG_NO_THEMEBIT

#define EKG_NO_THEMEBIT   256

EKG_TRY_BEEP

#define EKG_TRY_BEEP   1

Dokumentacja definicji typów

dcc_close_handler_t

typedef void(* dcc_close_handler_t) (struct dcc_s *)

dcc_t

typedef struct dcc_s dcc_t

Dokumentacja typów wyliczanych

dcc_type_t

enum dcc_type_t

Wartości wyliczeń
DCC_NONE
DCC_SEND
DCC_GET
DCC_VOICE

disconnect_t

enum disconnect_t

Wartości wyliczeń
EKG_DISCONNECT_USER
EKG_DISCONNECT_NETWORK
EKG_DISCONNECT_FORCED
EKG_DISCONNECT_FAILURE
EKG_DISCONNECT_STOPPED

msgack_t

enum msgack_t

Wartości wyliczeń
EKG_ACK_DELIVERED
EKG_ACK_QUEUED
EKG_ACK_DROPPED
EKG_ACK_TEMPFAIL
EKG_ACK_UNKNOWN
EKG_ACK_MAX

msgclass_t

enum msgclass_t

Wartości wyliczeń
EKG_MSGCLASS_MESSAGE
EKG_MSGCLASS_CHAT
EKG_MSGCLASS_SYSTEM
EKG_MSGCLASS_LOG
EKG_MSGCLASS_NOT2US
EKG_MSGCLASS_SENT
EKG_MSGCLASS_SENT_CHAT
EKG_MSGCLASS_SENT_LOG
EKG_MSGCLASS_PRIV_STATUS

Dokumentacja funkcji

dcc_active_get()

int dcc_active_get

(

dcc_t *

)

dcc_active_set()

int dcc_active_set	(	dcc_t *	,
		int
	)

dcc_add()

dcc_t* dcc_add	(	session_t *	session,
		const char *	uid,
		dcc_type_t	type,
		void *	priv
	)

dcc_add()

dcc_close()

int dcc_close

(

dcc_t *

d

)

dcc_close_handler_get()

dcc_close_handler_t dcc_close_handler_get

(

dcc_t *

)

dcc_close_handler_set()

int dcc_close_handler_set	(	dcc_t *	,
		dcc_close_handler_t
	)

dcc_filename_get()

const char* dcc_filename_get

(

dcc_t *

)

dcc_filename_set()

int dcc_filename_set	(	dcc_t *	,
		const char *
	)

dcc_id_get()

int dcc_id_get

(

dcc_t *

)

dcc_offset_get()

int dcc_offset_get

(

dcc_t *

)

dcc_offset_set()

int dcc_offset_set	(	dcc_t *	,
		int
	)

dcc_private_get()

void* dcc_private_get

(

dcc_t *

)

dcc_private_set()

int dcc_private_set	(	dcc_t *	,
		void *
	)

dcc_size_get()

int dcc_size_get

(

dcc_t *

)

dcc_size_set()

int dcc_size_set	(	dcc_t *	,
		int
	)

dcc_started_get()

time_t dcc_started_get

(

dcc_t *

)

dcc_type_get()

dcc_type_t dcc_type_get

(

dcc_t *

)

dcc_uid_get()

const char* dcc_uid_get

(

dcc_t *

)

message_print()

char* message_print	(	const char *	session,
		const char *	sender,
		const char **	rcpts,
		const char *	text,
		const guint32 *	format,
		time_t	sent,
		int	mclass,
		const char *	seq,
		int	dobeep,
		int	secure
	)

protocol_connected_emit()

int protocol_connected_emit

(

const session_t *

s

)

protocol_disconnected_emit()

int protocol_disconnected_emit	(	const session_t *	s,
		const char *	reason,
		int	type
	)

protocol_init()

void protocol_init

(

)

protocol_init()

Init communication between core and PROTOCOL plugins

Here, we register main communication channels like:

• status changes: PROTOCOL_STATUS
  
• message I/O: PROTOCOL_MESSAGE
  
• acknowledge of messages: PROTOCOL_MESSAGE_ACK
  
• misc user events like typing notifies:PROTOCOL_XSTATE
  
• session connection/disconnection: PROTOCOL_CONNECTED and PROTOCOL_DISCONNECTED
• roster changes: USERLIST_ADDED and USERLIST_REMOVED and USERLIST_RENAMED

Zobacz również

query_connect() - Function to add listener on specified events.

query_emit() - Function to emit specified events.

protocol_message_ack_emit()

int protocol_message_ack_emit	(	const session_t *	s,
		const char *	rcpt,
		const char *	seq,
		int	status
	)

protocol_message_emit()

int protocol_message_emit	(	const session_t *	s,
		const char *	uid,
		char **	rcpts,
		const char *	text,
		const guint32 *	format,
		time_t	sent,
		int	mclass,
		const char *	seq,
		int	dobeep,
		int	secure
	)

protocol_status_emit()

int protocol_status_emit	(	const session_t *	s,
		const char *	uid,
		int	status,
		char *	descr,
		time_t	when
	)

protocol_uid()

char* protocol_uid	(	const char *	proto,
		const char *	target
	)

protocol_xstate_emit()

int protocol_xstate_emit	(	const session_t *	s,
		const char *	uid,
		int	state,
		int	offstate
	)

Dokumentacja zmiennych

dccs

dcc_t* dccs