IrcChannel Class Reference

An IRC channel. More...

#include <ircbot/ircchannel.h>

Public Member Functions
const char *	IrcChannel_name (const IrcChannel *self)
	The name of the channel. More...
const IrcServer *	IrcChannel_server (const IrcChannel *self)
	The server of the channel. More...
int	IrcChannel_isJoined (const IrcChannel *self)
	Whether the bot is currently on this channel. More...
const IBHashTable *	IrcChannel_nicks (const IrcChannel *self)
	A hash table of all the nicks currently on the channel. More...

Detailed Description

An IRC channel.

Member Function Documentation

IrcChannel_isJoined()

int IrcChannel_isJoined

(

const IrcChannel *

self

)

Whether the bot is currently on this channel.

Parameters

self	the IrcChannel

Returns

1 if the channel is currently joined, 0 otherwise

IrcChannel_name()

const char * IrcChannel_name

(

const IrcChannel *

self

)

The name of the channel.

Parameters

self	the IrcChannel

Returns

the name of the channel

IrcChannel_nicks()

const IBHashTable * IrcChannel_nicks

(

const IrcChannel *

self

)

A hash table of all the nicks currently on the channel.

The nicks are the keys of the hash table, the value is always the name of the channel.

Parameters

self	the IrcChannel

Returns

a hash table of the nicks

IrcChannel_server()

const IrcServer * IrcChannel_server

(

const IrcChannel *

self

)

The server of the channel.

Parameters

self	the IrcChannel

Returns

the server of the channel

---

The documentation for this class was generated from the following file:

• ircbot/ircchannel.h