Class: Gio::SocketControlMessage

Inherits:

Object

• Object
• Gio::SocketControlMessage

Defined in:

(unknown)

Overview

Class structure for GSocket::ControlMessage.

Instance Method Summary

• #level ⇒ Integer

  Returns the “level” (i.e. the originating protocol) of the control message.

• #msg_type ⇒ Integer

  Returns the protocol specific type of the control message.

• #serialize(data) ⇒ nil

  Converts the data in the message to bytes placed in the message.

• #size ⇒ Integer

  Returns the space required for the control message, not including headers or alignment.

Instance Method Details

#level ⇒ Integer

Returns the “level” (i.e. the originating protocol) of the control message. This is often SOL_SOCKET.

Returns:

• (Integer) —

  an integer describing the level

#msg_type ⇒ Integer

Returns the protocol specific type of the control message. For instance, for UNIX fd passing this would be SCM_RIGHTS.

Returns:

• (Integer) —

  an integer describing the type of control message

#serialize(data) ⇒ nil

Converts the data in the message to bytes placed in the message.

data is guaranteed to have enough space to fit the size returned by g_socket_control_message_get_size() on this object.

Parameters:

• data (GObject) —

  A buffer to write data to

Returns:

• (nil)

#size ⇒ Integer

Returns the space required for the control message, not including headers or alignment.

Returns:

• (Integer) —

  The number of bytes required.