GebrCommSocket

GebrCommSocket

Synopsis

#define             GEBR_COMM_SOCKET_TYPE
                    GebrCommSocket;
                    GebrCommSocketClass;
void                gebr_comm_socket_close              (GebrCommSocket *);
void                gebr_comm_socket_flush              (GebrCommSocket *);
void                gebr_comm_socket_set_blocking       (GebrCommSocket *,
                                                         gboolean );
enum GebrCommSocketState  gebr_comm_socket_get_state    (GebrCommSocket *);
enum GebrCommSocketError  gebr_comm_socket_get_last_error
                                                        (GebrCommSocket *);
GebrCommSocketAddress  gebr_comm_socket_get_address     (GebrCommSocket *);
gulong              gebr_comm_socket_bytes_available    (GebrCommSocket *);
gulong              gebr_comm_socket_bytes_to_write     (GebrCommSocket *);
GByteArray *        gebr_comm_socket_read               (GebrCommSocket *,
                                                         gsize );
GString *           gebr_comm_socket_read_string        (GebrCommSocket *,
                                                         gsize );
GByteArray *        gebr_comm_socket_read_all           (GebrCommSocket *);
GString *           gebr_comm_socket_read_string_all    (GebrCommSocket *);
void                gebr_comm_socket_write              (GebrCommSocket *,
                                                         GByteArray *);
void                gebr_comm_socket_write_string       (GebrCommSocket *,
                                                         GString *);
void                gebr_comm_socket_write_immediately  (GebrCommSocket *,
                                                         GByteArray *);
void                gebr_comm_socket_write_string_immediately
                                                        (GebrCommSocket *,
                                                         GString *);

Object Hierarchy

  GObject
   +----GebrCommSocket
         +----GebrCommChannelSocket
         +----GebrCommListenSocket
         +----GebrCommStreamSocket

Signals

  "error"                                          : Run Last / Action
  "ready-read"                                     : Run Last / Action
  "ready-write"                                    : Run Last / Action

Description

Details

GEBR_COMM_SOCKET_TYPE

#define GEBR_COMM_SOCKET_TYPE			(gebr_comm_socket_get_type())

GebrCommSocket

typedef struct _GebrCommSocket GebrCommSocket;

GebrCommSocketClass

typedef struct {
	GObjectClass parent;

	/* virtual */
	void (*connected) (GebrCommSocket * self);
	void (*disconnected) (GebrCommSocket * self);
	void (*new_connection) (GebrCommSocket * self);
	/* signals */
	void (*ready_read) (GebrCommSocket * self);
	void (*ready_write) (GebrCommSocket * self);
	void (*error) (GebrCommSocket * self, enum GebrCommSocketError error);
} GebrCommSocketClass;

gebr_comm_socket_close ()

void                gebr_comm_socket_close              (GebrCommSocket *);

gebr_comm_socket_flush ()

void                gebr_comm_socket_flush              (GebrCommSocket *);

gebr_comm_socket_set_blocking ()

void                gebr_comm_socket_set_blocking       (GebrCommSocket *,
                                                         gboolean );

gebr_comm_socket_get_state ()

enum GebrCommSocketState  gebr_comm_socket_get_state    (GebrCommSocket *);

gebr_comm_socket_get_last_error ()

enum GebrCommSocketError  gebr_comm_socket_get_last_error
                                                        (GebrCommSocket *);

gebr_comm_socket_get_address ()

GebrCommSocketAddress  gebr_comm_socket_get_address     (GebrCommSocket *);

gebr_comm_socket_bytes_available ()

gulong              gebr_comm_socket_bytes_available    (GebrCommSocket *);

gebr_comm_socket_bytes_to_write ()

gulong              gebr_comm_socket_bytes_to_write     (GebrCommSocket *);

gebr_comm_socket_read ()

GByteArray *        gebr_comm_socket_read               (GebrCommSocket *,
                                                         gsize );

gebr_comm_socket_read_string ()

GString *           gebr_comm_socket_read_string        (GebrCommSocket *,
                                                         gsize );

gebr_comm_socket_read_all ()

GByteArray *        gebr_comm_socket_read_all           (GebrCommSocket *);

gebr_comm_socket_read_string_all ()

GString *           gebr_comm_socket_read_string_all    (GebrCommSocket *);

gebr_comm_socket_write ()

void                gebr_comm_socket_write              (GebrCommSocket *,
                                                         GByteArray *);

gebr_comm_socket_write_string ()

void                gebr_comm_socket_write_string       (GebrCommSocket *,
                                                         GString *);

gebr_comm_socket_write_immediately ()

void                gebr_comm_socket_write_immediately  (GebrCommSocket *,
                                                         GByteArray *);

gebr_comm_socket_write_string_immediately ()

void                gebr_comm_socket_write_string_immediately
                                                        (GebrCommSocket *,
                                                         GString *);

Signal Details

The "error" signal

void                user_function                      (GebrCommSocket *gebrcommsocket,
                                                        gint            arg1,
                                                        gpointer        user_data)           : Run Last / Action

The "ready-read" signal

void                user_function                      (GebrCommSocket *gebrcommsocket,
                                                        gpointer        user_data)           : Run Last / Action

The "ready-write" signal

void                user_function                      (GebrCommSocket *gebrcommsocket,
                                                        gpointer        user_data)           : Run Last / Action