C2S Class Reference

#include <c2s.h>

Inheritance diagram for C2S:

Public Member Functions
	C2S (Router &router, ConfigManager &cm, const gloox::LogSink &logInstance, SM &sm, bool threading=false, const gloox::JID &name=gloox::JID("c2s."+GLOOXD_DOMAIN))
virtual	~C2S ()
void	run ()
void	registerStreamFeature (StreamFeature *feature)
void	setStrictXMPP (bool enable)
void	setSupportRecipientUnavailable (bool value)
bool	supportRecipientUnavailable () const

Additional Inherited Members
Private Member Functions inherited from ComponentBase
	ComponentBase (Router &_router, ConfigManager &cm, const gloox::JID &_name, const gloox::LogSink &_logInstance)
virtual	~ComponentBase ()
const gloox::JID &	name () const

Detailed Description

The base class for the Client-to-Server (C2S) component.

You can handle any number of domains on any number of interfaces/ports with a single C2S instance.

Author

Jakob Schroeter js@ca.nosp@m.maya.nosp@m..net

Since

0.1

Definition at line 52 of file c2s.h.

Constructor & Destructor Documentation

C2S	(	Router &	router,
		ConfigManager &	cm,
		const gloox::LogSink &	logInstance,
		SM &	sm,
		bool	threading = false,
		const gloox::JID &	name = gloox::JID( "c2s." + GLOOXD_DOMAIN )
	)

Instantiates a new C2S object.

Parameters

router	The local Router.
cm	The local ConfigManager.
logInstance	The LogSink to use for logging.
sm	The local session manager's name. Default: sm.
threading	Whether this C2S instance runs in its own thread. Default: false.
name	An internal name by which this c2s is known. Default: c2s.

Definition at line 42 of file c2s.cpp.

~C2S ( )

virtual

Virtual destructor.

Definition at line 51 of file c2s.cpp.

Member Function Documentation

void registerStreamFeature ( StreamFeature *  feature )

inline

Registers a new StreamFeature derived object. A copy will be used by any new client connections.

Parameters

feature

A new stream feature.

Note

For a list of stream features supported by default see derived classes of StreamFeature. These include at least: STARTTLS, SASL Auth (PLAIN only), Stream Compression, IQ Bind, IQ Session.

Definition at line 93 of file c2s.h.

void run

(

)

Starts processing incoming events. Blocks if the threading parameter to the constructor is true.

Definition at line 64 of file c2s.cpp.

void setStrictXMPP ( bool  enable )

inline

Enables or disables a set of rules that enforce strict XMPP. Currently, only a version='1.0' stream attribute is required if this is enabled. Enabled by default.

Parameters

enable

True to enable, false to disable strict XMPP.

Since

0.3

Definition at line 104 of file c2s.h.

void setSupportRecipientUnavailable ( bool  value )

inline

Whether to send a <recipient-unavailable /> error response if an IQ stanza is sent to a recipient that is not available.

Parameters

value

true to respond to IQ stanzas with recipient-unavailable as appropriate, or false to ignore such IQ stanzas.

Note

If you do not want one connected user to quickly know via an IQ stanza that another recipient is unavailable, you can disable this.

Since

0.3

Definition at line 116 of file c2s.h.

bool supportRecipientUnavailable ( ) const

inline

Whether to send a <recipient-unavailable /> error response if an IQ stanza is sent to a recipient that is not available.

Returns

true if we respond to IQ stanzas with recipient-unavailable as appropriate, or false if we ignore such IQ stanzas.

Since

0.3

Definition at line 128 of file c2s.h.

---

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

• c2s.h
• c2s.cpp