TpaManager

TpaManager

Synopsis




#define             TPA_MANAGER_GET_PRIVATE             (obj)
                    TpaManagerPrivate;
                    TpaManager;
gchar*              tpa_manager_get_name                (TpaManager *self);
GPtrArray*          tpa_manager_get_supported_protocols (TpaManager *self);
GPtrArray*          tpa_manager_get_connections         (TpaManager *self);
TpaParameters*      tpa_manager_get_protocol_parameters (TpaManager *self,
                                                         const gchar *protocol);
gboolean            tpa_manager_is_running              (TpaManager *self);
TpaConnection*      tpa_manager_request_connection      (TpaManager *self,
                                                         const gchar *protocol,
                                                         TpaParameters *parameters);
gboolean            tpa_manager_supports                (TpaManager *self,
                                                         const gchar *protocol);

Object Hierarchy


  GObject
   +----TpaObject
         +----TpaManager

Properties


  "file"                     gchararray            : Read / Write / Construct Only
  "services"                 gpointer              : Read / Write / Construct Only

Signals


  "new-connection"                                 : Run Last / Has Details

Description

Details

TPA_MANAGER_GET_PRIVATE()

#define             TPA_MANAGER_GET_PRIVATE(obj)

obj :

TpaManagerPrivate

typedef struct _TpaManagerPrivate TpaManagerPrivate;


TpaManager

typedef struct _TpaManager 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_protocols ()

GPtrArray*          tpa_manager_get_supported_protocols (TpaManager *self);

Get protocols supported by the connection manager instance.

self : TpaManager instance.
Returns : GPtrArray with all protocols 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_protocol_parameters ()

TpaParameters*      tpa_manager_get_protocol_parameters (TpaManager *self,
                                                         const gchar *protocol);

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

self : TpaManager instance.
protocol : protocol that will be used.
Returns : a instance of TpaParameters with all parameters.

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,
                                                         const gchar *protocol,
                                                         TpaParameters *parameters);

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

self : TpaManager instance.
protocol : protocol that will be used.
parameters : list of params for connection.
Returns : TpaConnection instance or NULL if fail.

tpa_manager_supports ()

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

Checks wether TpaManager instance support the givin protocol.

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

Property Details

The "file" property

  "file"                     gchararray            : Read / Write / Construct Only

file.

Default value: NULL


The "services" property

  "services"                 gpointer              : Read / Write / Construct Only

services.

Signal Details

The "new-connection" signal

void                user_function                      (TpaManager *tpamanager,
                                                        gpointer    arg1,
                                                        gpointer    user_data)       : Run Last / Has Details

tpamanager : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.