TpCMParamFilter ()

gboolean
(*TpCMParamFilter) (const TpCMParamSpec *paramspec,
                    GValue *value,
                    GError **error);

Signature of a callback used to validate and/or normalize user-provided CM parameter values.

tp_cm_param_filter_string_nonempty ()

gboolean
tp_cm_param_filter_string_nonempty (const TpCMParamSpec *paramspec,
                                    GValue *value,
                                    GError **error);

A TpCMParamFilter which rejects empty strings.

tp_cm_param_filter_uint_nonzero ()

gboolean
tp_cm_param_filter_uint_nonzero (const TpCMParamSpec *paramspec,
                                 GValue *value,
                                 GError **error);

A TpCMParamFilter which rejects zero, useful for server port numbers.

TpCMParamSetter ()

void
(*TpCMParamSetter) (const TpCMParamSpec *paramspec,
                    const GValue *value,
                    gpointer params);

The signature of a callback used to set a parameter within the opaque data structure used for a protocol.

Since 0.7.0

tp_cm_param_setter_offset ()

void
tp_cm_param_setter_offset (const TpCMParamSpec *paramspec,
                           const GValue *value,
                           gpointer params);

A TpCMParamSetter which sets parameters by dereferencing an offset from params . If paramspec->offset is G_MAXSIZE, the parameter is deemed obsolete, and is accepted but ignored.

Since 0.7.0

TpBaseConnectionManagerNewConnFunc ()

TpBaseConnection *
(*TpBaseConnectionManagerNewConnFunc) (TpBaseConnectionManager *self,
                                       const gchar *proto,
                                       TpIntset *params_present,
                                       void *parsed_params,
                                       GError **error);

A function that will return a new connection according to the parsed parameters; used to implement RequestConnection.

The connection manager base class will register the bus name for the new connection, and place a reference to it in its table of connections until the connection's shutdown process finishes.

TpBaseConnectionManagerGetInterfacesFunc ()

GPtrArray *
(*TpBaseConnectionManagerGetInterfacesFunc)
                               (TpBaseConnectionManager *self);

Signature of an implementation of TpBaseConnectionManagerClass.get_interfaces virtual function.

Implementation must first chainup on parent class implementation and then add extra interfaces into the GPtrArray.

1
2
3
4
5
6
7
8
9
10
11
12

static GPtrArray *
my_connection_manager_get_interfaces (TpBaseConnectionManager *self)
{
  GPtrArray *interfaces;

  interfaces = TP_BASE_CONNECTION_MANAGER_CLASS (
      my_connection_manager_parent_class)->get_interfaces (self);

  g_ptr_array_add (interfaces, TP_IFACE_BADGERS);

  return interfaces;
}

Since 0.19.4

tp_base_connection_manager_get_dbus_connection ()

GDBusConnection *
tp_base_connection_manager_get_dbus_connection
                               (TpBaseConnectionManager *self);

Since 0.11.3

tp_base_connection_manager_register ()

gboolean
tp_base_connection_manager_register (TpBaseConnectionManager *self);

Register the connection manager with an appropriate object path as determined from its cm_dbus_name , and register the appropriate well-known bus name.

tp_base_connection_manager_add_protocol ()

void
tp_base_connection_manager_add_protocol
                               (TpBaseConnectionManager *self,
                                TpBaseProtocol *protocol);

Add a protocol object to the set of supported protocols.

struct TpCMParamSpec

struct TpCMParamSpec {
    const gchar *name;
    const gchar *dtype;
    GType gtype;
    guint flags;
    gconstpointer def;
    gsize offset;

    TpCMParamFilter filter;
    gconstpointer filter_data;

    gconstpointer setter_data;
};

Structure representing a connection manager parameter, as accepted by RequestConnection.

In addition to the fields documented here, there is one gpointer field which must currently be NULL. A meaning may be defined for it in a future version of telepathy-glib.

TpCMProtocolSpec

typedef struct {
    const gchar *name;
    const TpCMParamSpec *parameters;
    gpointer (*params_new) (void);
    void (*params_free) (gpointer);
    TpCMParamSetter set_param;
} TpCMProtocolSpec;

Structure representing a connection manager protocol.

In addition to the fields documented here, there are three gpointer fields which must currently be NULL. A meaning may be defined for these in a future version of telepathy-glib.

struct TpBaseConnectionManager

struct TpBaseConnectionManager;

A base class for connection managers. There are no interesting public fields in the instance structure.

struct TpBaseConnectionManagerClass

struct TpBaseConnectionManagerClass {
    GObjectClass parent_class;

    const char *cm_dbus_name;

    TpBaseConnectionManagerGetInterfacesFunc get_interfaces;
};

The class structure for TpBaseConnectionManager.

In addition to the fields documented here, there are some gpointer fields which must currently be NULL (a meaning may be defined for these in a future version of telepathy-glib).

Since 0.99.1

The “dbus-connection” property

  “dbus-connection”          GDBusConnection *

This object's connection to D-Bus. Read-only except during construction.

If this property is NULL or omitted during construction, the object will automatically attempt to connect to the session bus with g_bus_get_sync() just after it is constructed; if this fails, a warning will be logged with g_warning(), and this property will remain NULL.

Flags: Read / Write / Construct Only

Since 0.11.3

The “interfaces” property

  “interfaces”               GStrv

The set of D-Bus interfaces available on this ConnectionManager, other than ConnectionManager itself.

Flags: Read

Since 0.11.11

The “protocols” property

  “protocols”                GHashTable_gchararray+GHashTable_gchararray+GValue__*

The Protocol objects available on this ConnectionManager.

Flags: Read

Since 0.11.11

The “no-more-connections” signal

void
user_function (TpBaseConnectionManager *arg0,
               gpointer                 user_data)

Emitted when the table of active connections becomes empty. tp_run_connection_manager() uses this to detect when to shut down the connection manager.

Flags: Has Details