EvdPeer

EvdPeer

Synopsis

enum                EvdMessageType;
struct              EvdPeer;
struct              EvdPeerClass;
guint               evd_peer_backlog_get_length         (EvdPeer *self);
gchar *             evd_peer_backlog_pop_frame          (EvdPeer *self,
                                                         gsize *size);
gboolean            evd_peer_backlog_push_frame         (EvdPeer *self,
                                                         const gchar *frame,
                                                         gsize size,
                                                         GError **error);
gboolean            evd_peer_backlog_unshift_frame      (EvdPeer *self,
                                                         const gchar *frame,
                                                         gsize size,
                                                         GError **error);
void                evd_peer_close                      (EvdPeer *self,
                                                         gboolean gracefully);
const gchar *       evd_peer_get_id                     (EvdPeer *self);
gboolean            evd_peer_is_alive                   (EvdPeer *self);
gboolean            evd_peer_is_closed                  (EvdPeer *self);
gchar *             evd_peer_pop_message                (EvdPeer *self,
                                                         gsize *size,
                                                         EvdMessageType *type);
gboolean            evd_peer_push_message               (EvdPeer *self,
                                                         const gchar *message,
                                                         gsize size,
                                                         EvdMessageType type,
                                                         GError **error);
gboolean            evd_peer_send                       (EvdPeer *self,
                                                         const gchar *buffer,
                                                         gsize size,
                                                         GError **error);
gboolean            evd_peer_send_text                  (EvdPeer *self,
                                                         const gchar *buffer,
                                                         GError **error);
void                evd_peer_touch                      (EvdPeer *self);
gboolean            evd_peer_unshift_message            (EvdPeer *self,
                                                         const gchar *message,
                                                         gsize size,
                                                         EvdMessageType type,
                                                         GError **error);

Object Hierarchy

  GObject
   +----EvdPeer

Properties

  "id"                       gchar*                : Read
  "transport"                GObject*              : Read / Write / Construct Only

Description

Details

enum EvdMessageType

typedef enum {
  EVD_MESSAGE_TYPE_BINARY = 0,
  EVD_MESSAGE_TYPE_TEXT   = 1
} EvdMessageType;


struct EvdPeer

struct EvdPeer;


struct EvdPeerClass

struct EvdPeerClass {
  GObjectClass parent_class;

  /* padding for future expansion */
  void (* _padding_0_) (void);
  void (* _padding_1_) (void);
  void (* _padding_2_) (void);
  void (* _padding_3_) (void);
  void (* _padding_4_) (void);
  void (* _padding_5_) (void);
  void (* _padding_6_) (void);
  void (* _padding_7_) (void);
};


evd_peer_backlog_get_length ()

guint               evd_peer_backlog_get_length         (EvdPeer *self);


evd_peer_backlog_pop_frame ()

gchar *             evd_peer_backlog_pop_frame          (EvdPeer *self,
                                                         gsize *size);


evd_peer_backlog_push_frame ()

gboolean            evd_peer_backlog_push_frame         (EvdPeer *self,
                                                         const gchar *frame,
                                                         gsize size,
                                                         GError **error);


evd_peer_backlog_unshift_frame ()

gboolean            evd_peer_backlog_unshift_frame      (EvdPeer *self,
                                                         const gchar *frame,
                                                         gsize size,
                                                         GError **error);


evd_peer_close ()

void                evd_peer_close                      (EvdPeer *self,
                                                         gboolean gracefully);


evd_peer_get_id ()

const gchar *       evd_peer_get_id                     (EvdPeer *self);


evd_peer_is_alive ()

gboolean            evd_peer_is_alive                   (EvdPeer *self);


evd_peer_is_closed ()

gboolean            evd_peer_is_closed                  (EvdPeer *self);


evd_peer_pop_message ()

gchar *             evd_peer_pop_message                (EvdPeer *self,
                                                         gsize *size,
                                                         EvdMessageType *type);

size :

. [allow-none]

type :

. [allow-none]

Returns :

. [transfer full]

Since 0.1.20


evd_peer_push_message ()

gboolean            evd_peer_push_message               (EvdPeer *self,
                                                         const gchar *message,
                                                         gsize size,
                                                         EvdMessageType type,
                                                         GError **error);

Since 0.1.20


evd_peer_send ()

gboolean            evd_peer_send                       (EvdPeer *self,
                                                         const gchar *buffer,
                                                         gsize size,
                                                         GError **error);


evd_peer_send_text ()

gboolean            evd_peer_send_text                  (EvdPeer *self,
                                                         const gchar *buffer,
                                                         GError **error);


evd_peer_touch ()

void                evd_peer_touch                      (EvdPeer *self);


evd_peer_unshift_message ()

gboolean            evd_peer_unshift_message            (EvdPeer *self,
                                                         const gchar *message,
                                                         gsize size,
                                                         EvdMessageType type,
                                                         GError **error);

Since 0.1.20

Property Details

The "id" property

  "id"                       gchar*                : Read

A string representing the UUID of the peer.

Default value: NULL


The "transport" property

  "transport"                GObject*              : Read / Write / Construct Only

Transport object which this peer uses for sending and receiving data.