class Gio::InputMessage

Overview

Structure used for scatter/gather data input when receiving multiple messages or packets in one go. You generally pass in an array of empty #GInputVectors and the operation will use all the buffers as if they were one buffer, and will set @bytes_received to the total number of bytes received across all #GInputVectors.

This structure closely mirrors struct mmsghdr and struct msghdr from the POSIX sockets API (see man 2 recvmmsg).

If @address is non-nil then it is set to the source address the message was received from, and the caller must free it afterwards.

If @control_messages is non-nil then it is set to an array of control messages received with the message (if any), and the caller must free it afterwards. @num_control_messages is set to the number of elements in this array, which may be zero.

Flags relevant to this message will be returned in @flags. For example, MSG_EOR or MSG_TRUNC.

Defined in:

lib/gi-crystal/src/auto/gio-2.0/input_message.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pointer : Pointer(Void), transfer : GICrystal::Transfer) #

def self.new(data : LibGio::InputMessage, transfer : GICrystal::Transfer) #

def self.new(num_vectors : UInt32? = nil, bytes_received : UInt64? = nil, flags : Int32? = nil) #

Instance Method Detail

def ==(other : self) : Bool #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def address : Gio::SocketAddress? #

def address! #

def bytes_received : UInt64 #

def bytes_received=(value : UInt64) #

def control_messages : Enumerable(Gio::SocketControlMessage)? #

def control_messages! #

def flags : Int32 #

def flags=(value : Int32) #

def num_control_messages : Pointer(UInt32)? #

def num_control_messages! #

def num_vectors : UInt32 #

def num_vectors=(value : UInt32) #

def to_unsafe #

def vectors : Enumerable(Gio::InputVector)? #

def vectors! #