InspIRCd  2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations
Public Member Functions | List of all members
ProtocolInterface Class Reference

Public Member Functions

virtual bool SendEncapsulatedData (const parameterlist &encap)
 
virtual void SendMetaData (Extensible *target, const std::string &key, const std::string &data)
 
virtual void SendTopic (Channel *channel, std::string &topic)
 
virtual void SendMode (const std::string &target, const parameterlist &modedata, const std::vector< TranslateType > &translate)
 
virtual void SendModeStr (const std::string &target, const std::string &modeline)
 
virtual void SendSNONotice (const std::string &snomask, const std::string &text)
 
virtual void PushToClient (User *target, const std::string &rawline)
 
virtual void SendChannelPrivmsg (Channel *target, char status, const std::string &text)
 
virtual void SendChannelNotice (Channel *target, char status, const std::string &text)
 
virtual void SendUserPrivmsg (User *target, const std::string &text)
 
virtual void SendUserNotice (User *target, const std::string &text)
 
virtual void GetServerList (ProtoServerList &sl)
 

Member Function Documentation

virtual void ProtocolInterface::GetServerList ( ProtoServerList &  sl)
inlinevirtual

Fill a list of servers and information about them.

Parameters
slThe list of servers to fill. XXX: document me properly, this is shit.
virtual void ProtocolInterface::PushToClient ( User target,
const std::string &  rawline 
)
inlinevirtual

Send raw data to a remote client.

Parameters
targetThe user to push data to.
rawlineThe raw IRC protocol line to deliver (":me NOTICE you :foo", whatever).
virtual void ProtocolInterface::SendChannelNotice ( Channel target,
char  status,
const std::string &  text 
)
inlinevirtual

Send a notice to a channel.

Parameters
targetThe channel to message.
statusThe status character (e.g. %) required to recieve.
textThe message to send.
virtual void ProtocolInterface::SendChannelPrivmsg ( Channel target,
char  status,
const std::string &  text 
)
inlinevirtual

Send a message to a channel.

Parameters
targetThe channel to message.
statusThe status character (e.g. %) required to recieve.
textThe message to send.
virtual bool ProtocolInterface::SendEncapsulatedData ( const parameterlist &  encap)
inlinevirtual

Send an ENCAP message to one or more linked servers. See the protocol documentation for the purpose of ENCAP.

Parameters
encapThis is a list of string parameters, the first of which must be a server ID or glob matching servernames. The second must be a subcommand. All subsequent parameters are dependant on the subcommand. ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
Returns
True if the message was sent out (target exists)
virtual void ProtocolInterface::SendMetaData ( Extensible target,
const std::string &  key,
const std::string &  data 
)
inlinevirtual

Send metadata for an object to other linked servers.

Parameters
targetThe object to send metadata for.
keyThe 'key' of the data, e.g. "swhois" for swhois desc on a user
dataThe string representation of the data
virtual void ProtocolInterface::SendMode ( const std::string &  target,
const parameterlist &  modedata,
const std::vector< TranslateType > &  translate 
)
inlinevirtual

Send mode changes for an object.

Parameters
targetThe channel name or user to send mode changes for.
modedataThe mode changes to send.
translateA list of translation types
virtual void ProtocolInterface::SendModeStr ( const std::string &  target,
const std::string &  modeline 
)
inlinevirtual

Convenience function, string wrapper around the above.

virtual void ProtocolInterface::SendSNONotice ( const std::string &  snomask,
const std::string &  text 
)
inlinevirtual

Send a notice to users with a given snomask.

Parameters
snomaskThe snomask required for the message to be sent.
textThe message to send.
virtual void ProtocolInterface::SendTopic ( Channel channel,
std::string &  topic 
)
inlinevirtual

Send a topic change for a channel

Parameters
channelThe channel to change the topic for.
topicThe new topic to use for the channel.
virtual void ProtocolInterface::SendUserNotice ( User target,
const std::string &  text 
)
inlinevirtual

Send a notice to a user.

Parameters
targetThe user to message.
textThe message to send.
virtual void ProtocolInterface::SendUserPrivmsg ( User target,
const std::string &  text 
)
inlinevirtual

Send a message to a user.

Parameters
targetThe user to message.
textThe message to send.

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