struct GNetworkConnection

struct GNetworkConnection;

An empty typedef for objects which implement the GNetworkConnectionIface interface.

enum GNetworkConnectionStatus

typedef enum /* <prefix=GNETWORK_CONNECTION> */
{
  GNETWORK_CONNECTION_CLOSING,
  GNETWORK_CONNECTION_CLOSED,
  GNETWORK_CONNECTION_OPENING,
  GNETWORK_CONNECTION_OPEN
}
GNetworkConnectionStatus;

An enumeration of the possible connection states a GNetworkConnectionIface implementation may be in.

enum GNetworkConnectionType

typedef enum /* <prefix=GNETWORK_CONNECTION> */
{
  GNETWORK_CONNECTION_INVALID,

  GNETWORK_CONNECTION_CLIENT,
  GNETWORK_CONNECTION_SERVER
}
GNetworkConnectionType;

An enumeration of the types of connections that can exist.

gnetwork_connection_open ()

void        gnetwork_connection_open        (GNetworkConnection *connection);

Starts the connection process for connection.

Since 1.0

gnetwork_connection_close ()

void        gnetwork_connection_close       (GNetworkConnection *connection);

Closes the connection in question.

Since 1.0

gnetwork_connection_send ()

void        gnetwork_connection_send        (GNetworkConnection *connection,
                                             gconstpointer data,
                                             glong length);

Sends the data in data through connection. If length is less than one, data is assumed to be terminated by 0. This function will perform the necessary calculations for length. After calling the implementation's send function, the "send" signal will be emitted.

Since 1.0

struct GNetworkConnectionIface

struct GNetworkConnectionIface {

  /* Signals */
  void (*received)           (GNetworkConnection * connection,
			      gconstpointer data,
			      gulong length);
  void (*sent)		     (GNetworkConnection * connection,
			      gconstpointer data,
			      gulong length);
  void (*error)		     (GNetworkConnection * connection,
			      GError * error);

  /* Methods */
  GNetworkConnectionFunc      open;
  GNetworkConnectionFunc      close;
  GNetworkConnectionSendFunc  send;

};

The interface structure for implementers.

gnetwork_connection_received ()

void        gnetwork_connection_received    (GNetworkConnection *connection,
                                             gconstpointer data,
                                             gulong length);

Emits the "received" signal for connection, using the values in data and length. Implementations of the GNetworkConnectionIface interface should use this function when data has been received.

Since 1.0

gnetwork_connection_sent ()

void        gnetwork_connection_sent        (GNetworkConnection *connection,
                                             gconstpointer data,
                                             gulong length);

Emits the "sent" signal for connection, using the values in data and length. Implementations of the GNetworkConnectionIface interface should call this function when data has been sent.

Since 1.0

gnetwork_connection_error ()

void        gnetwork_connection_error       (GNetworkConnection *connection,
                                             const GError *error);

Emits the "error" signal for connection, using error. Callers to this function should use their own error domains.

Since 1.0

GNetworkConnectionFunc ()

void        (*GNetworkConnectionFunc)       (GNetworkConnection *connection);

A basic implementation function type.

GNetworkConnectionSendFunc ()

void        (*GNetworkConnectionSendFunc)   (GNetworkConnection *connection,
                                             gconstpointer data,
                                             gsize length);

An implementation function type used to send data.

GNETWORK_CONNECTION_CALL_PARENT()

#define     GNETWORK_CONNECTION_CALL_PARENT(obj,method,args)

A macro to call a parent class' GNetworkConnectionIface implementation of method. Typically, this would be used to "chain up" after overriding a method or signal callback.

The "buffer-size" property

  "buffer-size"          guint                 : Read / Write / Construct

The maximum size in bytes of outgoing and incoming data packets.

Default value: 2048

The "bytes-received" property

  "bytes-received"       gulong                : Read

The number of bytes received through this connection.

The "bytes-sent" property

  "bytes-sent"           gulong                : Read

The number of bytes sent through this connection.

The "connection-type" property

  "connection-type"      GNetworkConnectionType  : Read / Write / Construct

The type of connection represented by the implementing object.

Default value: GNETWORK_CONNECTION_CLIENT

The "status" property

  "status"               GNetworkConnectionStatus  : Read

The status of this connection.

Default value: GNETWORK_CONNECTION_CLOSED

The "error" signal

void        user_function                  (GNetworkConnection *gnetworkconnection,
                                            GError *arg1,
                                            gpointer user_data);

This signal is emitted when an error occurs in the connection.

The "received" signal

void        user_function                  (GNetworkConnection *gnetworkconnection,
                                            gpointer arg1,
                                            gulong arg2,
                                            gpointer user_data);

This signal is emitted when data has been received.

The "sent" signal

void        user_function                  (GNetworkConnection *gnetworkconnection,
                                            gpointer arg1,
                                            gulong arg2,
                                            gpointer user_data);

This signal is emitted when data has been sent.