TpaConnection

TpaConnection

Synopsis




#define             TPA_CONNECTION_GET_PRIVATE          (obj)
                    TpaConnectionPrivate;
                    TpaConnection;
const gchar*        tpa_connection_get_protocol         (TpaConnection *self);
void                tpa_connection_connect              (TpaConnection *self);
void                tpa_connection_disconnect           (TpaConnection *self);
void                tpa_connection_create_channel       (TpaConnection *self,
                                                         TpaChannelType type,
                                                         TpaChannelTarget *target);
TpaConnectionStatus tpa_connection_get_status           (TpaConnection *self);
TpaContactList*     tpa_connection_get_contactlist      (TpaConnection *self);
GPtrArray*          tpa_connection_get_open_channels    (TpaConnection *self);
TpaUserContact*     tpa_connection_get_user_contact     (TpaConnection *self);

Object Hierarchy


  GObject
   +----TpaObject
         +----TpaConnection

Signals


  "channel-created"                                : Run Last / Has Details
  "status-changed"                                 : Run Last / Has Details

Description

Details

TPA_CONNECTION_GET_PRIVATE()

#define             TPA_CONNECTION_GET_PRIVATE(obj)

obj :

TpaConnectionPrivate

typedef struct _TpaConnectionPrivate TpaConnectionPrivate;


TpaConnection

typedef struct _TpaConnection TpaConnection;


tpa_connection_get_protocol ()

const gchar*        tpa_connection_get_protocol         (TpaConnection *self);

Return the connection's protocol.

self : TpaConnection instance.
Returns :

tpa_connection_connect ()

void                tpa_connection_connect              (TpaConnection *self);

Request the connection establishment. Result will be return asynchronously by signal status-changed.

self : TpaConnection instance.

tpa_connection_disconnect ()

void                tpa_connection_disconnect           (TpaConnection *self);

Closes the connection.

self : TpaConnection instance.

tpa_connection_create_channel ()

void                tpa_connection_create_channel       (TpaConnection *self,
                                                         TpaChannelType type,
                                                         TpaChannelTarget *target);

Create a new channel of the given type to the given target.

self : TpaConnection instance.
type : TpaChannelType type.
target : TpaChannelTarget instance.

tpa_connection_get_status ()

TpaConnectionStatus tpa_connection_get_status           (TpaConnection *self);

Return the connection status.

self : TpaConnection instance.
Returns : TpaConnectionStatus status.

tpa_connection_get_contactlist ()

TpaContactList*     tpa_connection_get_contactlist      (TpaConnection *self);

Return connection's contact list.

self : TpaConnection instance.
Returns :

tpa_connection_get_open_channels ()

GPtrArray*          tpa_connection_get_open_channels    (TpaConnection *self);

Return all currently open channels on the connection.

self : TpaConnection instance.
Returns : GPtrArray array of TpaChannel channels.

tpa_connection_get_user_contact ()

TpaUserContact*     tpa_connection_get_user_contact     (TpaConnection *self);

Return connection's user contact.

self : TpaConnection instance.
Returns :

Signal Details

The "channel-created" signal

void                user_function                      (TpaConnection *tpaconnection,
                                                        TpaChannel    *arg1,
                                                        gpointer       user_data)          : Run Last / Has Details

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

The "status-changed" signal

void                user_function                      (TpaConnection *tpaconnection,
                                                        guint          arg1,
                                                        guint          arg2,
                                                        gpointer       user_data)          : Run Last / Has Details

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