XMPPServerInfo Class Reference

Server info class. More...

#include <xmpputils.h>

Inheritance diagram for XMPPServerInfo:

RefObject GenObject

List of all members.

Public Types

enum  ServerFlag {
  NoAutoRestart = 0x0001, KeepRoster = 0x0002, TlsRequired = 0x0004, OldStyleAuth = 0x0008,
  AllowPlainAuth = 0x0020
}

Public Member Functions

 XMPPServerInfo (const char *name, const char *address, int port, const char *password, const char *identity, const char *fullidentity, int flags)
 XMPPServerInfo (const char *name, int port)
const String & address () const
const String & name () const
const int port () const
const String & password () const
const String & identity () const
const String & fullIdentity () const
bool flag (int mask) const

Static Public Attributes

static TokenDict s_flagName []


Detailed Description

Server info class.

This class holds informations about a server


Member Enumeration Documentation

enum ServerFlag

Server flags


Constructor & Destructor Documentation

XMPPServerInfo ( const char *  name,
const char *  address,
int  port,
const char *  password,
const char *  identity,
const char *  fullidentity,
int  flags 
) [inline]

Constructor. Construct a full server info object

Parameters:
name Server domain name
address IP address
port IP port
password Component only: Password used for authentication
identity Component only: The stream identity used when connecting
fullidentity Component only: The user identity
flags Server flags

XMPPServerInfo ( const char *  name,
int  port 
) [inline]

Constructor. Construct a partial server info object

Parameters:
name Server domain name
port IP port


Member Function Documentation

const String& address (  )  const [inline]

Get the server's address

Returns:
The server's address

bool flag ( int  mask  )  const [inline]

Check if a given flag (or mask) is set

Returns:
True if the flag is set

const String& fullIdentity (  )  const [inline]

Get the server's full identity

Returns:
The server's full identity

const String& identity (  )  const [inline]

Get the server's identity

Returns:
The server's identity

const String& name (  )  const [inline]

Get the server's domain name

Returns:
The server's domain name

const String& password (  )  const [inline]

Get the server's port used to connect to

Returns:
The server's port used to connect to

const int port (  )  const [inline]

Get the server's port used to connect to

Returns:
The server's port used to connect to


Member Data Documentation

TokenDict s_flagName[] [static]

Flag names dictionary


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

Generated on Sun Dec 7 21:45:27 2008 for Yate by  doxygen 1.5.7.1