From a96514c284514116300794696f062c7fa6b1f79f Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 19:17:41 +0000 Subject: Added new docs for class InspIRCd and globals.h etc git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2451 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/inspircd_8h.html | 1210 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 1210 insertions(+) create mode 100644 docs/module-doc/inspircd_8h.html (limited to 'docs/module-doc/inspircd_8h.html') diff --git a/docs/module-doc/inspircd_8h.html b/docs/module-doc/inspircd_8h.html new file mode 100644 index 000000000..7fb7590fc --- /dev/null +++ b/docs/module-doc/inspircd_8h.html @@ -0,0 +1,1210 @@ + + +InspIRCd: inspircd.h File Reference + + + +

+home » brain » inspircd-cvs » inspircd » include

inspircd.h File Reference

#include "inspircd_config.h"
+#include <string>
+#include <stdio.h>
+#include <unistd.h>
+#include <signal.h>
+#include <time.h>
+#include <netdb.h>
+#include <string.h>
+#include <errno.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/stat.h>
+#include <netinet/in.h>
+#include <arpa/inet.h>
+#include <deque>
+#include "inspircd_io.h"
+#include "inspircd_util.h"
+#include "users.h"
+#include "channels.h"
+#include "socket.h"
+ +

+Include dependency graph for inspircd.h:

+ + + + + + + +

+This graph shows which files directly or indirectly include this file:

+ + + + + + + + + + + + +

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes
class serverstats
class InspIRCd

Defines
#define ERROR   -1
#define TRUE   1
#define FALSE   0
#define MAXSOCKS   64
#define MAXCOMMAND   32
#define WM_AND   1
#define WM_OR   2
#define TYPE_USER   1
#define TYPE_CHANNEL   2
#define TYPE_SERVER   3
#define IS_LOCAL(x)   (x->fd > -1)
#define IS_REMOTE(x)   (x->fd < 0)
#define IS_MODULE_CREATED(x)   (x->fd == FD_MAGIC_NUMBER)

Typedefs
typedef void( handlerfunc )(char **, int, userrec *)

Functions
void force_nickchange (userrec *user, const char *newnick)
void kill_link (userrec *user, const char *r)
void kill_link_silent (userrec *user, const char *r)
void call_handler (const char *commandname, char **parameters, int pcnt, userrec *user)
bool is_valid_cmd (const char *commandname, int pcnt, userrec *user)
std::string GetRevision ()
int loop_call (handlerfunc fn, char **parameters, int pcnt, userrec *u, int start, int end, int joins)
void AddWhoWas (userrec *u)
void ConnectUser (userrec *user)
userrec * ReHashNick (char *Old, char *New)
char * ModuleError ()
void AddOper (userrec *user)
void DeleteOper (userrec *user)
void handle_version (char **parameters, int pcnt, userrec *user)
void AddServerName (std::string servername)
const char * FindServerNamePtr (std::string servername)
std::string GetVersionString ()
void * dns_task (void *arg)
void process_buffer (const char *cmdbuf, userrec *user)
void FullConnectUser (userrec *user)
+

Define Documentation

+ + + + +
+ + + + +
#define ERROR -1
+
+ + + + + +
+ + + +
+ +
+Definition at line 49 of file inspircd.h. +
+Referenced by InspSocket::InspSocket().
+

+ + + + +
+ + + + +
#define FALSE 0
+
+ + + + + +
+ + + +
+ +
+Definition at line 51 of file inspircd.h.
+

+ + + + +
+ + + + + + + + + +
#define IS_LOCAL ( x ) (x->fd > -1)
+
+ + + + + +
+ + + +
+ +
+Definition at line 66 of file inspircd.h.
+

+ + + + +
+ + + + + + + + + +
#define IS_MODULE_CREATED ( x ) (x->fd == FD_MAGIC_NUMBER)
+
+ + + + + +
+ + + +
+ +
+Definition at line 68 of file inspircd.h.
+

+ + + + +
+ + + + + + + + + +
#define IS_REMOTE ( x ) (x->fd < 0)
+
+ + + + + +
+ + + +
+ +
+Definition at line 67 of file inspircd.h.
+

+ + + + +
+ + + + +
#define MAXCOMMAND 32
+
+ + + + + +
+ + + +
+ +
+Definition at line 53 of file inspircd.h.
+

+ + + + +
+ + + + +
#define MAXSOCKS 64
+
+ + + + + +
+ + + +
+ +
+Definition at line 52 of file inspircd.h.
+

+ + + + +
+ + + + +
#define TRUE 1
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file inspircd.h.
+

+ + + + +
+ + + + +
#define TYPE_CHANNEL 2
+
+ + + + + +
+ + + +
+ +
+Definition at line 63 of file inspircd.h.
+

+ + + + +
+ + + + +
#define TYPE_SERVER 3
+
+ + + + + +
+ + + +
+ +
+Definition at line 64 of file inspircd.h.
+

+ + + + +
+ + + + +
#define TYPE_USER 1
+
+ + + + + +
+ + + +
+ +
+Definition at line 62 of file inspircd.h.
+

+ + + + +
+ + + + +
#define WM_AND 1
+
+ + + + + +
+ + + +
+ +
+Definition at line 57 of file inspircd.h.
+

+ + + + +
+ + + + +
#define WM_OR 2
+
+ + + + + +
+ + + +
+ +
+Definition at line 58 of file inspircd.h.
+

Typedef Documentation

+ + + + +
+ + + + +
typedef void( handlerfunc)(char **, int, userrec *)
+
+ + + + + +
+ + + +
+ +
+Definition at line 70 of file inspircd.h.
+

Function Documentation

+ + + + +
+ + + + + + + + + +
void AddOper ( userrec * user )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + +
void AddServerName ( std::string servername )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + +
void AddWhoWas ( userrec * u )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void call_handler ( const char * commandname,
char ** parameters,
int pcnt,
userrec * user
)
+
+ + + + + +
+ + + +
+ +
+Referenced by Server::CallCommandHandler().
+

+ + + + +
+ + + + + + + + + +
void ConnectUser ( userrec * user )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + +
void DeleteOper ( userrec * user )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + +
void* dns_task ( void * arg )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + +
const char* FindServerNamePtr ( std::string servername )
+
+ + + + + +
+ + + +
+ +
+Referenced by userrec::userrec().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
void force_nickchange ( userrec * user,
const char * newnick
)
+
+ + + + + +
+ + + +
+ +
+Referenced by Server::ChangeUserNick().
+

+ + + + +
+ + + + + + + + + +
void FullConnectUser ( userrec * user )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + +
std::string GetRevision ( )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + +
std::string GetVersionString ( )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void handle_version ( char ** parameters,
int pcnt,
userrec * user
)
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool is_valid_cmd ( const char * commandname,
int pcnt,
userrec * user
)
+
+ + + + + +
+ + + +
+ +
+Referenced by Server::IsValidModuleCommand().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
void kill_link ( userrec * user,
const char * r
)
+
+ + + + + +
+ + + +
+ +
+Referenced by Server::PseudoToUser(), and Server::QuitUser().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
void kill_link_silent ( userrec * user,
const char * r
)
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int loop_call ( handlerfunc fn,
char ** parameters,
int pcnt,
userrec * u,
int start,
int end,
int joins
)
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + +
char* ModuleError ( )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
void process_buffer ( const char * cmdbuf,
userrec * user
)
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
userrec* ReHashNick ( char * Old,
char * New
)
+
+ + + + + +
+ + + +
+
+

Generated on Wed Dec 14 19:16:18 2005 for InspIRCd by + +

1.4.4-20050815

+ + -- cgit v1.2.3


Classes
class	serverstats
class	InspIRCd
Defines
#define	ERROR -1
#define	TRUE 1
#define	FALSE 0
#define	MAXSOCKS 64
#define	MAXCOMMAND 32
#define	WM_AND 1
#define	WM_OR 2
#define	TYPE_USER 1
#define	TYPE_CHANNEL 2
#define	TYPE_SERVER 3
#define	IS_LOCAL(x) (x->fd > -1)
#define	IS_REMOTE(x) (x->fd < 0)
#define	IS_MODULE_CREATED(x) (x->fd == FD_MAGIC_NUMBER)
Typedefs
typedef void(	handlerfunc )(char *, int, userrec )
Functions
void	force_nickchange (userrec user, const char newnick)
void	kill_link (userrec user, const char r)
void	kill_link_silent (userrec user, const char r)
void	call_handler (const char commandname, char parameters, int pcnt, userrec user)
bool	is_valid_cmd (const char commandname, int pcnt, userrec user)
std::string	GetRevision ()
int	loop_call (handlerfunc fn, char *parameters, int pcnt, userrec u, int start, int end, int joins)
void	AddWhoWas (userrec *u)
void	ConnectUser (userrec *user)
userrec *	ReHashNick (char Old, char New)
char *	ModuleError ()
void	AddOper (userrec *user)
void	DeleteOper (userrec *user)
void	handle_version (char *parameters, int pcnt, userrec user)
void	AddServerName (std::string servername)
const char *	FindServerNamePtr (std::string servername)
std::string	GetVersionString ()
void *	dns_task (void *arg)
void	process_buffer (const char cmdbuf, userrec user)
void	FullConnectUser (userrec *user)