WockyConnector

typedef struct _WockyConnector WockyConnector;

WockyConnectorClass

typedef struct {
    GObjectClass parent_class;
} WockyConnectorClass;

WockyConnectorPrivate

typedef struct _WockyConnectorPrivate WockyConnectorPrivate;

enum WockyConnectorError

typedef enum {
  WOCKY_CONNECTOR_ERROR_UNKNOWN,
  WOCKY_CONNECTOR_ERROR_IN_PROGRESS,
  WOCKY_CONNECTOR_ERROR_BAD_JID,
  WOCKY_CONNECTOR_ERROR_NON_XMPP_V1_SERVER,
  WOCKY_CONNECTOR_ERROR_BAD_FEATURES,
  WOCKY_CONNECTOR_ERROR_TLS_UNAVAILABLE,
  WOCKY_CONNECTOR_ERROR_TLS_REFUSED,
  WOCKY_CONNECTOR_ERROR_TLS_SESSION_FAILED,
  WOCKY_CONNECTOR_ERROR_BIND_UNAVAILABLE,
  WOCKY_CONNECTOR_ERROR_BIND_FAILED,
  WOCKY_CONNECTOR_ERROR_BIND_INVALID,
  WOCKY_CONNECTOR_ERROR_BIND_DENIED,
  WOCKY_CONNECTOR_ERROR_BIND_CONFLICT,
  WOCKY_CONNECTOR_ERROR_BIND_REJECTED,
  WOCKY_CONNECTOR_ERROR_SESSION_FAILED,
  WOCKY_CONNECTOR_ERROR_SESSION_DENIED,
  WOCKY_CONNECTOR_ERROR_SESSION_CONFLICT,
  WOCKY_CONNECTOR_ERROR_SESSION_REJECTED,
  WOCKY_CONNECTOR_ERROR_INSECURE,
  WOCKY_CONNECTOR_ERROR_REGISTRATION_FAILED,
  WOCKY_CONNECTOR_ERROR_REGISTRATION_UNAVAILABLE,
  WOCKY_CONNECTOR_ERROR_REGISTRATION_UNSUPPORTED,
  WOCKY_CONNECTOR_ERROR_REGISTRATION_EMPTY,
  WOCKY_CONNECTOR_ERROR_REGISTRATION_CONFLICT,
  WOCKY_CONNECTOR_ERROR_REGISTRATION_REJECTED,
  WOCKY_CONNECTOR_ERROR_UNREGISTER_FAILED,
  WOCKY_CONNECTOR_ERROR_UNREGISTER_DENIED,
} WockyConnectorError;

The WockyConnector specific errors that can occur while connecting.

wocky_connector_error_quark ()

GQuark              wocky_connector_error_quark         (void);

WOCKY_CONNECTOR_ERROR

#define WOCKY_CONNECTOR_ERROR (wocky_connector_error_quark ())

Get access to the error quark of the connector.

wocky_connector_connect_finish ()

WockyXmppConnection * wocky_connector_connect_finish    (WockyConnector *self,
                                                         GAsyncResult *res,
                                                         gchar **jid,
                                                         gchar **sid,
                                                         GError **error);

Called by the callback passed to wocky_connector_connect_async().

wocky_connector_register_finish ()

WockyXmppConnection * wocky_connector_register_finish   (WockyConnector *self,
                                                         GAsyncResult *res,
                                                         gchar **jid,
                                                         gchar **sid,
                                                         GError **error);

Called by the callback passed to wocky_connector_register_async().

wocky_connector_connect_async ()

void                wocky_connector_connect_async       (WockyConnector *self,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback cb,
                                                         gpointer user_data);

Connect to the account/server specified by the self. cb should invoke wocky_connector_connect_finish().

wocky_connector_new ()

WockyConnector *    wocky_connector_new                 (const gchar *jid,
                                                         const gchar *pass,
                                                         const gchar *resource,
                                                         WockyAuthRegistry *auth_registry,
                                                         WockyTLSHandler *tls_handler);

Connect to the account/server specified by self. To set other WockyConnector properties, use g_object_new() instead.

wocky_connector_register_async ()

void                wocky_connector_register_async      (WockyConnector *self,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback cb,
                                                         gpointer user_data);

Connect to the account/server specified by self, register (set up) the account there and then log in to it. cb should invoke wocky_connector_register_finish().

wocky_connector_unregister_async ()

void                wocky_connector_unregister_async    (WockyConnector *self,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback cb,
                                                         gpointer user_data);

Connect to the account/server specified by self, and unregister (cancel) the account there. cb should invoke wocky_connector_unregister_finish().

wocky_connector_unregister_finish ()

gboolean            wocky_connector_unregister_finish   (WockyConnector *self,
                                                         GAsyncResult *res,
                                                         GError **error);

Called by the callback passed to wocky_connector_unregister_async().

wocky_connector_set_auth_registry ()

void                wocky_connector_set_auth_registry   (WockyConnector *self,
                                                         WockyAuthRegistry *registry);

The "auth-registry" property

  "auth-registry"            WockyAuthRegistry*    : Read / Write / Construct Only

An authentication registry that holds handlers for different authentication mechanisms, arbitrates mechanism selection and relays challenges and responses between the handlers and the connection.

The "email" property

  "email"                    gchar*                : Read / Write

The XMPP account's email address (optional, MAY be required by the server if we are registering an account, not required otherwise).

Default value: NULL

The "encrypted-plain-auth-ok" property

  "encrypted-plain-auth-ok"  gboolean              : Read / Write / Construct

Whether PLAINTEXT auth is ok when encrypted.

Default value: TRUE

The "features" property

  "features"                 WockyStanza*          : Read

A WockyStanza instance, the last WockyStanza instance received by the connector during the connection procedure (there may be several, the most recent one always being the one we should refer to).

The "identity" property

  "identity"                 gchar*                : Read

JID + resource (a AT b SLASH c) that is in effect _after_ a successful resource binding operation. This is NOT guaranteed to be related to the JID specified in the original "jid" property. The resource, in particular, is often different, and with gtalk the domain is often different.

Default value: NULL

The "jid" property

  "jid"                      gchar*                : Read / Write

The XMPP account's JID (with or without a /resource).

Default value: NULL

The "legacy" property

  "legacy"                   gboolean              : Read / Write / Construct

Whether to attempt old-style (non-SASL) jabber auth.

Default value: FALSE

The "old-ssl" property

  "old-ssl"                  gboolean              : Read / Write / Construct

Whether to use old-style SSL-at-connect-time encryption rather than the more modern STARTTLS approach.

Default value: FALSE

The "password" property

  "password"                 gchar*                : Read / Write

XMPP Account password.

Default value: NULL

The "plaintext-auth-allowed" property

  "plaintext-auth-allowed"   gboolean              : Read / Write / Construct

Whether auth info can be sent in the clear (eg PLAINTEXT auth). This is independent of any encryption (TLS, SSL) that has been negotiated.

Default value: FALSE

The "resource" property

  "resource"                 gchar*                : Read / Write / Construct Only

The resource (sans '/') for this connection. Will be generated automatically if not set. May be altered by the server anyway upon successful binding.

Default value: NULL

The "session-id" property

  "session-id"               gchar*                : Read

The Session ID supplied by the server upon successfully connecting. May be useful later on as some XEPs suggest this value should be used at various stages as part of a hash or as an ID.

Default value: NULL

The "tls-handler" property

  "tls-handler"              WockyTLSHandler*      : Read / Write / Construct Only

A TLS handler that carries out the interactive verification of the TLS certitificates provided by the server.

The "tls-required" property

  "tls-required"             gboolean              : Read / Write / Construct

Whether we require successful tls/ssl negotiation to continue.

Default value: TRUE

The "xmpp-port" property

  "xmpp-port"                guint                 : Read / Write / Construct

Optional XMPP connect port. Any DNS SRV record will be ignored if this is set. (So the host will be either the WockyConnector:xmpp-server property or the domain part of the JID, in descending order of preference)

Allowed values: <= 65535

Default value: 0

The "xmpp-server" property

  "xmpp-server"              gchar*                : Read / Write

Optional XMPP connect server. Any DNS SRV record and the host specified in "jid" will be ignored if this is set. May be a hostname (fully qualified or otherwise), a dotted quad or an ipv6 address.

Default value: NULL