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

TpCMParamSpec

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

    TpCMParamFilter filter;
    gconstpointer filter_data;

    gconstpointer setter_data;
} TpCMParamSpec;

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.

TpBaseConnectionManager

typedef struct _TpBaseConnectionManager TpBaseConnectionManager;

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

TpBaseConnectionManagerClass

typedef struct {
    GObjectClass parent_class;

    const char *cm_dbus_name;
    const TpCMProtocolSpec *protocol_params;
    TpBaseConnectionManagerNewConnFunc new_connection;
} TpBaseConnectionManagerClass;

The class structure for TpBaseConnectionManager.

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

Changed in 0.7.1: it is a fatal error for cm_dbus_name not to conform to the specification.

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.

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.

The "no-more-connections" signal

void                user_function                      (TpBaseConnectionManager *arg0,
                                                        gpointer                 user_data)      : Run Last / Has Details

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