Dokumentacja pliku jogger.c

#include "ekg2.h"

Wykres zależności załączania dla jogger.c:

Definicje
#define	JOGGER_DATE   "2007-05-04"
#define	JOGGER_CMDFLAGS   SESSION_MUSTBELONG
#define	JOGGER_CMDFLAGS_TARGET   SESSION_MUSTBELONG|COMMAND_ENABLEREQPARAMS|COMMAND_PARAMASTARGET

Funkcje
static int	jogger_theme_init (void)
int	jogger_plugin_init (int prio)
static int	jogger_plugin_destroy (void)
void	jogger_localize_texts ()
void	jogger_free_texts (int real_free)
int	jogger_msghandler (void *data, va_list ap)
int	jogger_msg (const char *name, const char **params, session_t *session, const char *target, int quiet)
int	jogger_subscribe (const char *name, const char **params, session_t *session, const char *target, int quiet)
void	jogger_localize_headers ()
void	jogger_free_headers (int real_free)
int	jogger_prepare (const char *name, const char **params, session_t *session, const char *target, int quiet)
int	jogger_publish (const char *name, const char **params, session_t *session, const char *target, int quiet)
session_t *	jogger_session_find_uid (session_t *s, const char *uid)
static int	jogger_validate_uid (void *data, va_list ap)
static int	jogger_statuschanged (void *data, va_list ap)
static int	jogger_statuscleanup (void *data, va_list ap)
static void	jogger_usedchanged (session_t *s, const char *varname)
static int	jogger_null (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	jogger_print_version (void *data, va_list ap)
static int	jogger_newsession (void *data, va_list ap)
static int	jogger_postconfig (void *data, va_list ap)

Zmienne
plugin_t	jogger_plugin = { .name = "jogger", .pclass = PLUGIN_PROTOCOL , .destroy = jogger_plugin_destroy, .theme_init = jogger_theme_init }
static plugins_params_t	jogger_plugin_vars []
static const char *	jogger_protocols [] = { "jogger:", NULL }
static const struct protocol_plugin_priv	jogger_priv

Dokumentacja definicji

JOGGER_CMDFLAGS

#define JOGGER_CMDFLAGS   SESSION_MUSTBELONG

JOGGER_CMDFLAGS_TARGET

#define JOGGER_CMDFLAGS_TARGET   SESSION_MUSTBELONG|COMMAND_ENABLEREQPARAMS|COMMAND_PARAMASTARGET

JOGGER_DATE

#define JOGGER_DATE   "2007-05-04"

Dokumentacja funkcji

jogger_free_headers()

void jogger_free_headers

(

int

real_free

)

jogger_free_texts()

void jogger_free_texts

(

int

real_free

)

jogger_localize_headers()

void jogger_localize_headers

(

)

jogger_localize_texts()

void jogger_localize_texts

(

)

jogger_msg()

int jogger_msg	(	const char *	name,
		const char **	params,
		session_t *	session,
		const char *	target,
		int	quiet
	)

jogger_msghandler()

int jogger_msghandler	(	void *	data,
		va_list	ap
	)

jogger_newsession()

static int jogger_newsession ( void *  data, va_list  ap  )

static

jogger_null()

static int jogger_null ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

jogger_plugin_destroy()

static int jogger_plugin_destroy ( void  )

static

jogger_plugin_init()

int jogger_plugin_init

(

int

prio

)

jogger_postconfig()

static int jogger_postconfig ( void *  data, va_list  ap  )

static

jogger_prepare()

int jogger_prepare	(	const char *	name,
		const char **	params,
		session_t *	session,
		const char *	target,
		int	quiet
	)

jogger_print_version()

static int jogger_print_version ( void *  data, va_list  ap  )

static

jogger_publish()

int jogger_publish	(	const char *	name,
		const char **	params,
		session_t *	session,
		const char *	target,
		int	quiet
	)

jogger_session_find_uid()

session_t* jogger_session_find_uid	(	session_t *	s,
		const char *	uid
	)

jogger_session_find_uid() tries to find Jogger session connected with given session (s) and uid.

Zwraca

Session pointer or NULL if none match.

jogger_statuschanged()

static int jogger_statuschanged ( void *  data, va_list  ap  )

static

jogger_statuscleanup()

static int jogger_statuscleanup ( void *  data, va_list  ap  )

static

jogger_subscribe()

int jogger_subscribe	(	const char *	name,
		const char **	params,
		session_t *	session,
		const char *	target,
		int	quiet
	)

jogger_theme_init()

static int jogger_theme_init ( void  )

static

jogger_usedchanged()

static void jogger_usedchanged ( session_t *  s, const char *  varname  )

static

jogger_validate_uid()

static int jogger_validate_uid ( void *  data, va_list  ap  )

static

Dokumentacja zmiennych

jogger_plugin

plugin_t jogger_plugin = { .name = "jogger", .pclass = PLUGIN_PROTOCOL , .destroy = jogger_plugin_destroy, .theme_init = jogger_theme_init }

jogger_plugin_vars

plugins_params_t jogger_plugin_vars[]

static

Wartość początkowa:

= {
    {  "entry_file" ,  NULL ,  0 ,  VAR_STR ,  NULL , NULL },
    {  "entry_hash" ,  NULL ,  0 ,  VAR_STR ,  NULL , NULL },
    {  "ignore_outgoing_entries" ,  "0" ,  0 ,  VAR_BOOL ,  NULL , NULL },
    {  "log_formats" ,  "simple,sqlite" ,  0 ,  VAR_STR ,  NULL , NULL },
    {  "newentry_open_query" ,  "1" ,  0 ,  VAR_BOOL ,  NULL , NULL },
    {  "own_commentformat" ,  NULL ,  0 ,  VAR_STR ,  NULL , NULL },
    {  "own_commentformat_autodetect" ,  "1" ,  0 ,  VAR_BOOL ,  NULL , NULL },
    {  "used_session" ,  NULL ,  0 ,  VAR_STR ,  jogger_usedchanged , NULL },
    {  "used_uid" ,  NULL ,  0 ,  VAR_STR ,  jogger_usedchanged , NULL },
    {  "userlist_keep" ,  "0" ,  0 ,  VAR_BOOL ,  NULL , NULL },

    { NULL, NULL, 0, -1, NULL }
}

jogger_priv

const struct protocol_plugin_priv jogger_priv

static

Wartość początkowa:

= {
    .protocols  = jogger_protocols
}

jogger_protocols

const char* jogger_protocols[] = { "jogger:", NULL }

static