JIDResourceList Class Reference

A resource list. More...

#include <yatejabber.h>

Inheritance diagram for JIDResourceList:

Mutex

List of all members.

Public Member Functions

 JIDResourceList ()
bool add (const String &name)
bool add (JIDResource *resource)
void remove (JIDResource *resource, bool del=true)
void clear ()
JIDResourceget (const String &name)
JIDResourcegetFirst ()
JIDResourcegetAudio (bool availableOnly=true)

Friends

class XMPPUser
class JBPresence


Detailed Description

A resource list.

This class holds a resource list


Constructor & Destructor Documentation

JIDResourceList (  )  [inline]

Constructor


Member Function Documentation

bool add ( const String name  ) 

Add a resource to the list if a resource with the given name doesn't exists

Parameters:
name The resource name
Returns:
False if the the resource already exists in the list

bool add ( JIDResource resource  ) 

Add a resource to the list if not already there. Destroy the received resource if not added

Parameters:
resource The resource to add
Returns:
False if the the resource already exists in the list

void remove ( JIDResource resource,
bool  del = true 
) [inline]

Remove a resource from the list

Parameters:
resource The resource to remove
del True to delete the resource

void clear (  )  [inline]

Clear the list

JIDResource* get ( const String name  ) 

Get a resource with the given name

Parameters:
name The resource name
Returns:
A pointer to the resource or 0

JIDResource* getFirst (  )  [inline]

Get the first resource from the list

Returns:
A pointer to the resource or 0

References ObjList::get().

JIDResource* getAudio ( bool  availableOnly = true  ) 

Get the first resource with audio capability

Parameters:
availableOnly True to get only if available
Returns:
A pointer to the resource or 0


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

Generated on Mon Aug 11 16:18:53 2008 for Yate by  doxygen 1.5.6