RRChannel

Name

RRChannel -- 

Synopsis



#define     RR_DEFAULT_WINDOW_SIZE
#define     RR_CHANNEL_GTYPE_KEY_URI
void        (*RRWorkFunc)                   (RRChannel *channel,
                                             gpointer data);
gboolean    rr_channel_close                (RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic,
                                             GError **error);
gint        rr_channel_get_window_size      (RRChannel *channel);
void        rr_channel_set_window_size      (RRChannel *channel,
                                             gint size);
void        rr_channel_set_aggregate        (RRChannel *channel,
                                             gboolean aggregate);
gboolean    rr_channel_get_aggregate        (RRChannel *channel);
void        rr_channel_set_connection       (RRChannel *channel,
                                             RRConnection *connection);
RRConnection* rr_channel_get_connection     (RRChannel *channel);
gboolean    rr_channel_close_indication     (RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic,
                                             GError **error);
void        rr_channel_close_confirmation   (RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic);
void        rr_channel_frame_available      (RRChannel *channel,
                                             RRFrame *frame);
gboolean    rr_channel_send_frame           (RRChannel *channel,
                                             RRFrame *frame,
                                             GError **error);
gboolean    rr_channel_send_message         (RRChannel *channel,
                                             RRMessage *message,
                                             GError **error);
gboolean    rr_channel_client_init          (RRChannel *channel,
                                             GError **error);
gboolean    rr_channel_server_init          (RRChannel *channel,
                                             const gchar *piggyback,
                                             GError **error);
void        rr_channel_client_confirmation  (RRChannel *channel,
                                             const gchar *piggyback);
void        rr_channel_server_confirmation  (RRChannel *channel);
gboolean    rr_channel_flush                (RRChannel *channel,
                                             GError **error);
GObject*    rr_channel_get_active_item      (RRChannel *channel);
gboolean    rr_channel_remove_active_message
                                            (RRChannel *channel);
gboolean    rr_channel_out_queue_empty_p    (RRChannel *channel);
void        rr_channel_register_frame       (RRChannel *channel,
                                             RRFrame *frame);
const gchar* rr_channel_get_uri             (GType type);
void        rr_channel_set_uri              (GType type,
                                             const gchar *uri);
const gchar* rr_channel_get_piggyback       (RRChannel *channel);
void        rr_channel_set_piggyback        (RRChannel *channel,
                                             const gchar *piggyback);

Object Hierarchy


  GObject
   +----RRChannel

Description

Details

RR_DEFAULT_WINDOW_SIZE

#define RR_DEFAULT_WINDOW_SIZE 8192


RR_CHANNEL_GTYPE_KEY_URI

#define RR_CHANNEL_GTYPE_KEY_URI "RR_CHANNEL_URI"


RRWorkFunc ()

void        (*RRWorkFunc)                   (RRChannel *channel,
                                             gpointer data);

channel : 
data : 


rr_channel_close ()

gboolean    rr_channel_close                (RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic,
                                             GError **error);

channel : 
code : 
xml_lang : 
diagnostic : 
error : 
Returns : 


rr_channel_get_window_size ()

gint        rr_channel_get_window_size      (RRChannel *channel);

Returns the receive window size.

channel : A RRChannel.
Returns : the window size.


rr_channel_set_window_size ()

void        rr_channel_set_window_size      (RRChannel *channel,
                                             gint size);

Sets the size of the receive window.

channel : A RRChannel.
size : The new size of the receive window for channel.


rr_channel_set_aggregate ()

void        rr_channel_set_aggregate        (RRChannel *channel,
                                             gboolean aggregate);

Selects if the frames should be aggregated or not.

channel : a RRChannel
aggregate : TRUE or FALSE.


rr_channel_get_aggregate ()

gboolean    rr_channel_get_aggregate        (RRChannel *channel);

Returns TRUE if the frames are aggregated or FALSE if they are passed to rr_channel_frame_available directly.

channel : a RRChannel
Returns : TRUE or FALSE.


rr_channel_set_connection ()

void        rr_channel_set_connection       (RRChannel *channel,
                                             RRConnection *connection);

channel : 
connection : 


rr_channel_get_connection ()

RRConnection* rr_channel_get_connection     (RRChannel *channel);

channel : 
Returns : 


rr_channel_close_indication ()

gboolean    rr_channel_close_indication     (RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic,
                                             GError **error);

channel : 
code : 
xml_lang : 
diagnostic : 
error : 
Returns : 


rr_channel_close_confirmation ()

void        rr_channel_close_confirmation   (RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic);

channel : 
code : 
xml_lang : 
diagnostic : 


rr_channel_frame_available ()

void        rr_channel_frame_available      (RRChannel *channel,
                                             RRFrame *frame);

channel : 
frame : 


rr_channel_send_frame ()

gboolean    rr_channel_send_frame           (RRChannel *channel,
                                             RRFrame *frame,
                                             GError **error);

Enqueue frame for transmission on channel. Note: This function don't block until the frame is sent. And frame will be unref:ed after transmission.

channel : a RRChannel
frame : a RRFrame
error : location to return an error of type RR_ERROR or RR_BEEP_ERROR.
Returns : TRUE on success, FALSE on failure.


rr_channel_send_message ()

gboolean    rr_channel_send_message         (RRChannel *channel,
                                             RRMessage *message,
                                             GError **error);

Enqueue message for transmission on channel. Note: This function don't block until the message is sent. And message will be unref:ed after transmission.

channel : a RRChannel
message : a RRMessage
error : location to return an error of type RR_ERROR or RR_BEEP_ERROR.
Returns : TRUE on success, FALSE on failure.


rr_channel_client_init ()

gboolean    rr_channel_client_init          (RRChannel *channel,
                                             GError **error);

channel : 
error : 
Returns : 


rr_channel_server_init ()

gboolean    rr_channel_server_init          (RRChannel *channel,
                                             const gchar *piggyback,
                                             GError **error);

channel : 
piggyback : 
error : 
Returns : 


rr_channel_client_confirmation ()

void        rr_channel_client_confirmation  (RRChannel *channel,
                                             const gchar *piggyback);

channel : 
piggyback : 


rr_channel_server_confirmation ()

void        rr_channel_server_confirmation  (RRChannel *channel);

channel : 


rr_channel_flush ()

gboolean    rr_channel_flush                (RRChannel *channel,
                                             GError **error);

Blocks until all outgoing frames/messages are sent.

channel : A RRChannel
error : location to return an error of type RR_ERROR or RR_BEEP_ERROR.
Returns : TRUE on success, FALSE on failure.


rr_channel_get_active_item ()

GObject*    rr_channel_get_active_item      (RRChannel *channel);

channel : 
Returns : 


rr_channel_remove_active_message ()

gboolean    rr_channel_remove_active_message
                                            (RRChannel *channel);

channel : 
Returns : 


rr_channel_out_queue_empty_p ()

gboolean    rr_channel_out_queue_empty_p    (RRChannel *channel);

channel : 
Returns : 


rr_channel_register_frame ()

void        rr_channel_register_frame       (RRChannel *channel,
                                             RRFrame *frame);

channel : 
frame : 


rr_channel_get_uri ()

const gchar* rr_channel_get_uri             (GType type);

Get the URI the profile is associated with.

type : A GType
Returns : A uri or NULL


rr_channel_set_uri ()

void        rr_channel_set_uri              (GType type,
                                             const gchar *uri);

Associate an URI with the profile.

type : A GType
uri : An URI string.


rr_channel_get_piggyback ()

const gchar* rr_channel_get_piggyback       (RRChannel *channel);

channel : 
Returns : 


rr_channel_set_piggyback ()

void        rr_channel_set_piggyback        (RRChannel *channel,
                                             const gchar *piggyback);

channel : 
piggyback :