Protocol-specific Connection interfaces

Protocol-specific Connection interfaces — client-side wrappers for IRCCommand1

Synopsis

#include <telepathy-glib/telepathy-glib-dbus.h>

TpProxyPendingCall * tp_cli_connection_interface_irc_command1_call_send
                                                        (TpConnection *proxy,
                                                         gint timeout_ms,
                                                         const gchar *in_Command,
                                                         tp_cli_connection_interface_irc_command1_callback_for_send callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);
void                (*tp_cli_connection_interface_irc_command1_callback_for_send)
                                                        (TpConnection *proxy,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

Description

In IRC, it is sometimes necessary to send arbitrary strings to the server. The IRCCommand interface provides this functionality.

Details

tp_cli_connection_interface_irc_command1_call_send ()

TpProxyPendingCall * tp_cli_connection_interface_irc_command1_call_send
                                                        (TpConnection *proxy,
                                                         gint timeout_ms,
                                                         const gchar *in_Command,
                                                         tp_cli_connection_interface_irc_command1_callback_for_send callback,
                                                         gpointer user_data,
                                                         GDestroyNotify destroy,
                                                         GObject *weak_object);

Start a Send method call.

<tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Send an arbitrary IRC command to the server.</p> <p>For example, an IRC client receiving <code>/bip blreset</code> from the user might call this method with <code>BIP blreset</code> as argument which will send <code>BIP blreset</code> to the server.</p> <p>The command is supplied in UTF-8 (because strings on D-Bus are always UTF-8). It is transcoded into the connection's configured character set, if different, before sending to the server.</p>

proxy :

the TpProxy

timeout_ms :

the timeout in milliseconds, or -1 to use the default

in_Command :

Used to pass an 'in' argument: The command followed by its arguments.

callback :

called when the method call succeeds or fails; may be NULL to make a "fire and forget" call with no reply tracking

user_data :

user-supplied data passed to the callback; must be NULL if callback is NULL

destroy :

called with the user_data as argument, after the call has succeeded, failed or been cancelled; must be NULL if callback is NULL

weak_object :

If not NULL, a GObject which will be weakly referenced; if it is destroyed, this call will automatically be cancelled. Must be NULL if callback is NULL

Returns :

a TpProxyPendingCall representing the call in progress. It is borrowed from the object, and will become invalid when the callback is called, the call is cancelled or the TpProxy becomes invalid.

tp_cli_connection_interface_irc_command1_callback_for_send ()

void                (*tp_cli_connection_interface_irc_command1_callback_for_send)
                                                        (TpConnection *proxy,
                                                         const GError *error,
                                                         gpointer user_data,
                                                         GObject *weak_object);

Signature of the callback called when a Send method call succeeds or fails.

proxy :

the proxy on which the call was made

error :

NULL on success, or an error on failure

user_data :

user-supplied data

weak_object :

user-supplied object

See Also

TpConnection