PrevUpHomeBLib Reference ManualNext

BProxyClient

BProxyClient —

Synopsis




struct      BProxyClient;
BProxyClient* b_proxy_client_new            (const gchar *proxy_host,
                                             gint proxy_port,
                                             gint listen_port,
                                             BReceiverCallback callback,
                                             gpointer callback_data,
                                             GError **error);
gboolean    b_proxy_client_send_heartbeat   (BProxyClient *client);

Object Hierarchy


  GObject
   +----BReceiver
         +----BProxyClient

Description

Details

struct BProxyClient

struct BProxyClient;

b_proxy_client_new ()

BProxyClient* b_proxy_client_new            (const gchar *proxy_host,
                                             gint proxy_port,
                                             gint listen_port,
                                             BReceiverCallback callback,
                                             gpointer callback_data,
                                             GError **error);

Creates a new BProxyClient object, ready to use.

proxy_host : the blinkenproxy host
proxy_port : the blinkenproxy port
listen_port : the local port to listen to for Blinkenlights packages or -1 to bind to an arbitrary free local port
callback : the function to call when a new frame arrives
callback_data : data to pass to the callback
error : return location for a possible error
Returns : a newly allocate BProxyClient object

b_proxy_client_send_heartbeat ()

gboolean    b_proxy_client_send_heartbeat   (BProxyClient *client);

Make the client send a heartbeat packet. This function should be called periodically with the suggested interval of B_HEARTBEAT_INTERVAL. To achieve, use this function with g_timeout_add().

client : a BProxyClient
Returns : always TRUE
<< BPacketBProxyServer >>