Yate
Public Member Functions | Protected Attributes

ClientAccountList Class Reference

A client account list. More...

#include <yatecbase.h>

Inheritance diagram for ClientAccountList:
String Mutex GenObject Lockable

List of all members.

Public Member Functions

 ClientAccountList (const char *name)
ObjListaccounts ()
virtual ClientAccountfindAccount (const String &id, bool ref=false)
virtual ClientContactfindContact (const String &account, const String &id, bool ref=false)
virtual ClientContactfindContact (const String &builtId, bool ref=false)
virtual bool appendAccount (ClientAccount *account)
virtual void removeAccount (const String &id)

Protected Attributes

ObjList m_accounts

Detailed Description

A client account list.

This class holds an account list


Constructor & Destructor Documentation

ClientAccountList ( const char *  name) [inline]

Constructor

Parameters:
nameList's name used for debug purposes

Member Function Documentation

ObjList& accounts ( ) [inline]

Get the accounts list

Returns:
The accounts list
virtual bool appendAccount ( ClientAccount account) [virtual]

Append a new account. The account's reference counter is increased before

Parameters:
accountThe account to append
Returns:
True on succes, false if an account with the same id already exists
virtual ClientAccount* findAccount ( const String id,
bool  ref = false 
) [virtual]

Find an account

Parameters:
idThe account's id
refTrue to get a referenced pointer
Returns:
ClientAccount pointer or 0 if not found
virtual ClientContact* findContact ( const String builtId,
bool  ref = false 
) [virtual]

Find an account's contact from a built id

Parameters:
builtIdThe string containign the account and the contact
refTrue to get a referenced pointer
Returns:
ClientContact pointer or 0 if not found
virtual ClientContact* findContact ( const String account,
const String id,
bool  ref = false 
) [virtual]

Find an account's contact

Parameters:
accountThe account's id
idThe contact's id
refTrue to get a referenced pointer
Returns:
ClientContact pointer or 0 if not found
virtual void removeAccount ( const String id) [virtual]

Remove an account

Parameters:
idThe account's id

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