|
| virtual bool | SendEncapsulatedData (const std::string &targetmask, const std::string &cmd, const CommandBase::Params ¶ms, User *source=NULL) |
| |
| virtual void | BroadcastEncap (const std::string &cmd, const CommandBase::Params ¶ms, User *source=NULL, User *omit=NULL) |
| |
| virtual void | SendMetaData (Channel *chan, const std::string &key, const std::string &data) |
| |
| virtual void | SendMetaData (User *user, const std::string &key, const std::string &data) |
| |
| virtual void | SendMetaData (const std::string &key, const std::string &data) |
| |
| virtual void | SendSNONotice (char snomask, const std::string &text) |
| |
| virtual void | SendMessage (Channel *target, char status, const std::string &text, MessageType type=MSG_PRIVMSG) |
| |
| virtual void | SendMessage (User *target, const std::string &text, MessageType type=MSG_PRIVMSG) |
| |
| virtual void | GetServerList (ServerList &sl) |
| |
◆ BroadcastEncap()
| virtual void ProtocolInterface::BroadcastEncap |
( |
const std::string & |
cmd, |
|
|
const CommandBase::Params & |
params, |
|
|
User * |
source = NULL, |
|
|
User * |
omit = NULL |
|
) |
| |
|
inlinevirtual |
Send an ENCAP message to all servers. See the protocol documentation for the purpose of ENCAP.
- Parameters
-
| cmd | The ENCAP subcommand |
| params | List of string parameters which are dependent on the subcommand |
| source | The source of the message (prefix), must be a local user or a user behind 'omit' or NULL which is equivalent to the local server |
| omit | If non-NULL the message won't be sent in the direction of this server, useful for forwarding messages |
◆ GetServerList()
| virtual void ProtocolInterface::GetServerList |
( |
ServerList & |
sl | ) |
|
|
inlinevirtual |
Send a notice to a channel.
- Parameters
-
| target | The channel to message. |
| status | The status character (e.g. %) required to receive. |
| text | The message to send. Send a notice to a user. |
| target | The user to message. |
| text | The message to send. Fill a list of servers and information about them. |
| sl | The list of servers to fill. XXX: document me properly, this is shit. |
◆ SendEncapsulatedData()
| virtual bool ProtocolInterface::SendEncapsulatedData |
( |
const std::string & |
targetmask, |
|
|
const std::string & |
cmd, |
|
|
const CommandBase::Params & |
params, |
|
|
User * |
source = NULL |
|
) |
| |
|
inlinevirtual |
Send an ENCAP message to all servers matching a wildcard string. See the protocol documentation for the purpose of ENCAP.
- Parameters
-
| targetmask | The target server mask (can contain wildcards) |
| cmd | The ENCAP subcommand |
| params | List of string parameters which are dependent on the subcommand |
| source | The source of the message (prefix), must be a local user or NULL which means use local server |
- Returns
- Always true if the target mask contains wildcards; otherwise true if the server name was found, and the message was sent, false if it was not found. ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
◆ SendMessage() [1/2]
| virtual void ProtocolInterface::SendMessage |
( |
Channel * |
target, |
|
|
char |
status, |
|
|
const std::string & |
text, |
|
|
MessageType |
type = MSG_PRIVMSG |
|
) |
| |
|
inlinevirtual |
Send a message to a channel.
- Parameters
-
| target | The channel to message. |
| status | The status character (e.g. %) required to receive. |
| text | The message to send. |
| type | The message type (MSG_PRIVMSG or MSG_NOTICE) |
◆ SendMessage() [2/2]
| virtual void ProtocolInterface::SendMessage |
( |
User * |
target, |
|
|
const std::string & |
text, |
|
|
MessageType |
type = MSG_PRIVMSG |
|
) |
| |
|
inlinevirtual |
Send a message to a user.
- Parameters
-
| target | The user to message. |
| text | The message to send. |
| type | The message type (MSG_PRIVMSG or MSG_NOTICE) |
◆ SendMetaData() [1/3]
| virtual void ProtocolInterface::SendMetaData |
( |
Channel * |
chan, |
|
|
const std::string & |
key, |
|
|
const std::string & |
data |
|
) |
| |
|
inlinevirtual |
Send metadata for a channel to other linked servers.
- Parameters
-
| chan | The channel to send metadata for |
| key | The 'key' of the data, e.g. "swhois" for swhois desc on a user |
| data | The string representation of the data |
◆ SendMetaData() [2/3]
| virtual void ProtocolInterface::SendMetaData |
( |
const std::string & |
key, |
|
|
const std::string & |
data |
|
) |
| |
|
inlinevirtual |
Send metadata related to the server to other linked servers.
- Parameters
-
| key | The 'key' of the data |
| data | The string representation of the data |
◆ SendMetaData() [3/3]
| virtual void ProtocolInterface::SendMetaData |
( |
User * |
user, |
|
|
const std::string & |
key, |
|
|
const std::string & |
data |
|
) |
| |
|
inlinevirtual |
Send metadata for a user to other linked servers.
- Parameters
-
| user | The user to send metadata for |
| key | The 'key' of the data, e.g. "swhois" for swhois desc on a user |
| data | The string representation of the data |
◆ SendSNONotice()
| virtual void ProtocolInterface::SendSNONotice |
( |
char |
snomask, |
|
|
const std::string & |
text |
|
) |
| |
|
inlinevirtual |
Send a notice to users with a given snomask.
- Parameters
-
| snomask | The snomask required for the message to be sent. |
| text | The message to send. |
The documentation for this class was generated from the following file:
