Gjsify LogoGjsify Logo

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-%NULL 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-%NULL 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.

record

Hierarchy

  • InputMessage

Index

Constructors

Properties

address: SocketAddress

return location for a #GSocketAddress, or %NULL

field
bytes_received: number

will be set to the number of bytes that have been received

field
control_messages: SocketControlMessage[]

return location for a caller-allocated array of #GSocketControlMessages, or %NULL

field
flags: number

collection of #GSocketMsgFlags for the received message, outputted by the call

field
num_control_messages: number

return location for the number of elements in control_messages

field
num_vectors: number

the number of input vectors pointed to by vectors

field
vectors: InputVector[]

pointer to an array of input vectors

field
name: string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method