Gjsify LogoGjsify Logo

Represents a single message received off the network. For reliable connections, this is essentially just an array of buffers (specifically, from can be ignored). for non-reliable connections, it represents a single packet as received from the OS.

n_buffers may be -1 to indicate that buffers is terminated by a #GInputVector with a %NULL buffer pointer.

By providing arrays of #NiceInputMessages to functions like nice_agent_recv_messages(), multiple messages may be received with a single call, which is more efficient than making multiple calls in a loop. In this manner, nice_agent_recv_messages() is analogous to recvmmsg(); and #NiceInputMessage to struct mmsghdr.

record

Hierarchy

  • InputMessage

Index

Constructors

Properties

buffers: InputVector[]

unowned array of #GInputVector buffers to store data in for this message

field

return location to store the address of the peer who transmitted the message, or %NULL

field
length: number

total number of valid bytes contiguously stored in buffers

field
nBuffers: number

number of #GInputVectors in buffers, or -1 to indicate buffers is %NULL-terminated

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