chat_api.h File Reference

#include "globalincs/pstypes.h"

Go to the source code of this file.

Classes
struct	_Chat_user
struct	_Chat_channel
struct	_Chat_command

Macros
#define	PXO_CHAT_PORT   7117
#define	PXO_CHAT_MOTD_PREFIX   "!MOTD$#!"
#define	PXO_CHAT_END_OF_MOTD_PREFIX   "!EMOTD$#!"
#define	CC_USER_JOINING   1
#define	CC_USER_LEAVING   2
#define	CC_DISCONNECTED   3
#define	CC_KICKED   4
#define	CC_NICKCHANGED   5
#define	CC_YOURCHANNEL   6
#define	MAXLOCALSTRING   600
#define	MSG_REMOTE   0
#define	MSG_LOCAL   1

Typedefs
typedef struct _Chat_user	Chat_user
typedef struct _Chat_channel	Chat_channel
typedef struct _Chat_command	Chat_command

Functions
void	ChatInit (void)
int	ConnectToChatServer (char *serveraddr, char *nickname, char *trackerid)
void	DisconnectFromChatServer ()
char *	GetChatText ()
const char *	SendChatString (const char *line, int raw=0)
Chat_command *	GetChatCommand ()
char *	GetChatUserList ()
int	SetNewChatChannel (char *channel)
char *	GetChannelList (void)
char *	GetTrackerIdByUser (char *nickname)
char *	GetChannelByUser (char *nickname)
char *	ChatGetString (void)
char *	GetWordNum (int num, const char *l_String)
char *	ParseIRCMessage (char *Line, int iMode)
int	AddChatUser (char *nickname)
int	RemoveChatUser (char *nickname)
void	RemoveAllChatUsers (void)
void	AddChatCommandToQueue (int command, void *data, int len)
Chat_command *	GetChatCommandFromQueue (void)
void	FlushChatCommandQueue (void)
void	AddChannel (char *channel, ushort numusers, char *topic)
void	FlushChannelList (void)

Macro Definition Documentation

#define CC_DISCONNECTED   3

Definition at line 25 of file chat_api.h.

#define CC_KICKED   4

Definition at line 26 of file chat_api.h.

#define CC_NICKCHANGED   5

Definition at line 27 of file chat_api.h.

#define CC_USER_JOINING   1

Definition at line 23 of file chat_api.h.

#define CC_USER_LEAVING   2

Definition at line 24 of file chat_api.h.

#define CC_YOURCHANNEL   6

Definition at line 28 of file chat_api.h.

#define MAXLOCALSTRING   600

Definition at line 30 of file chat_api.h.

#define MSG_LOCAL   1

Definition at line 32 of file chat_api.h.

#define MSG_REMOTE   0

Definition at line 31 of file chat_api.h.

#define PXO_CHAT_END_OF_MOTD_PREFIX   "!EMOTD$#!"

Definition at line 20 of file chat_api.h.

#define PXO_CHAT_MOTD_PREFIX   "!MOTD$#!"

Definition at line 19 of file chat_api.h.

#define PXO_CHAT_PORT   7117

Definition at line 16 of file chat_api.h.

Typedef Documentation

typedef struct _Chat_channel Chat_channel

typedef struct _Chat_command Chat_command

typedef struct _Chat_user Chat_user

Function Documentation

void AddChannel	(	char *	channel,
		ushort	numusers,
		char *	topic
	)

Definition at line 1239 of file chat_api.cpp.

void AddChatCommandToQueue	(	int	command,
		void *	data,
		int	len
	)

Definition at line 1130 of file chat_api.cpp.

int AddChatUser

(

char *

nickname

)

Definition at line 564 of file chat_api.cpp.

char* ChatGetString

(

void

)

Definition at line 470 of file chat_api.cpp.

void ChatInit

(

void

)

Definition at line 74 of file chat_api.cpp.

int ConnectToChatServer	(	char *	serveraddr,
		char *	nickname,
		char *	trackerid
	)

Definition at line 111 of file chat_api.cpp.

void DisconnectFromChatServer

(

)

Call it to close the connection. It returns immediately

Definition at line 262 of file chat_api.cpp.

void FlushChannelList

(

void

)

Definition at line 1184 of file chat_api.cpp.

void FlushChatCommandQueue

(

void

)

Definition at line 1169 of file chat_api.cpp.

char* GetChannelByUser

(

char *

nickname

)

Definition at line 1301 of file chat_api.cpp.

char* GetChannelList

(

void

)

Definition at line 1199 of file chat_api.cpp.

Chat_command* GetChatCommand

(

)

Definition at line 382 of file chat_api.cpp.

Chat_command* GetChatCommandFromQueue

(

void

)

Definition at line 1156 of file chat_api.cpp.

char* GetChatText

(

)

Definition at line 292 of file chat_api.cpp.

char* GetChatUserList

(

)

Definition at line 391 of file chat_api.cpp.

char* GetTrackerIdByUser

(

char *

nickname

)

Definition at line 1270 of file chat_api.cpp.

char* GetWordNum	(	int	num,
		const char *	l_String
	)

Definition at line 525 of file chat_api.cpp.

char* ParseIRCMessage	(	char *	Line,
		int	iMode
	)

Definition at line 644 of file chat_api.cpp.

void RemoveAllChatUsers

(

void

)

Definition at line 629 of file chat_api.cpp.

int RemoveChatUser

(

char *

nickname

)

Definition at line 600 of file chat_api.cpp.

const char* SendChatString	(	const char *	line,
		int	raw
	)

Send a string to be sent as chat, or scanned for messages (/msg <user> string)

Definition at line 305 of file chat_api.cpp.

int SetNewChatChannel

(

char *

channel

)

Definition at line 429 of file chat_api.cpp.