TpaManager

TpaManager

Synopsis




#define             TPA_MANAGER_GET_PRIVATE             (obj)
                    TpaManagerPrivate;
                    TpaManager;
gchar*              tpa_manager_get_name                (TpaManager *self);
GPtrArray*          tpa_manager_get_supported_profiles  (TpaManager *self);
GPtrArray*          tpa_manager_get_connections         (TpaManager *self);
TpaProfile*         tpa_manager_get_profile             (TpaManager *self,
                                                         const gchar *profile);
gboolean            tpa_manager_is_running              (TpaManager *self);
TpaConnection*      tpa_manager_request_connection      (TpaManager *self,
                                                         TpaProfile *profile);
gboolean            tpa_manager_supports                (TpaManager *self,
                                                         const gchar *profile);

Description

Details

TPA_MANAGER_GET_PRIVATE()

#define             TPA_MANAGER_GET_PRIVATE(obj)

obj :

TpaManagerPrivate

typedef struct _TpaManagerPrivate TpaManagerPrivate;


TpaManager

typedef struct {
    TpaObject parent;
    TpaManagerPrivate *priv;
} TpaManager;


tpa_manager_get_name ()

gchar*              tpa_manager_get_name                (TpaManager *self);

Get name of the connection manager instance.

self : TpaManager instance.
Returns : Connection manager's name.

tpa_manager_get_supported_profiles ()

GPtrArray*          tpa_manager_get_supported_profiles  (TpaManager *self);

Get profiles supported by the connection manager instance.

self : TpaManager instance.
Returns : GPtrArray with all profiles supported.

tpa_manager_get_connections ()

GPtrArray*          tpa_manager_get_connections         (TpaManager *self);

Get all current connections.

self : TpaManager instance.
Returns : GPtrArray with all connections.

tpa_manager_get_profile ()

TpaProfile*         tpa_manager_get_profile             (TpaManager *self,
                                                         const gchar *profile);

Get a list of the parameters for the given profiles that is necessary for the RequestConnection method.

self : TpaManager instance.
profile :
Returns : a instance of TpaProfile.

tpa_manager_is_running ()

gboolean            tpa_manager_is_running              (TpaManager *self);

Checks if the connection manager is active.

self : TpaManager instance.
Returns : TRUE if it is active otherwise FALSE.

tpa_manager_request_connection ()

TpaConnection*      tpa_manager_request_connection      (TpaManager *self,
                                                         TpaProfile *profile);

Request a new TpaConnection instance. The instance state is disconnected to connect it call tpa_connection_connect.

self : TpaManager instance.
profile :
Returns : TpaConnection instance or NULL if fail.

tpa_manager_supports ()

gboolean            tpa_manager_supports                (TpaManager *self,
                                                         const gchar *profile);

Checks wether TpaManager instance support the givin protocol.

self : TpaManager instance.
profile : Profile name
Returns : TRUE if the instance support the protocol otherwise FALSE.