Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DatagramSocketOptions

Options used to configure a datagram socket.

Hierarchy

Index

Constructors

constructor

Methods

getActivityLogDataFormat

  • getActivityLogDataFormat(): any
  • Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.

    Returns any

getLogActivity

  • getLogActivity(): boolean
  • Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    Returns boolean

getMulticastNetworkInterface

  • getMulticastNetworkInterface(): string
  • Set the multicast network interface address

    Returns string

getMulticastTimeToLive

  • getMulticastTimeToLive(): number
  • Set the multicast ttl value

    Returns number

getReceiveBufferSize

  • getReceiveBufferSize(): number

getSendBufferSize

  • getSendBufferSize(): number
  • Set the TCP send buffer size

    Returns number

getTrafficClass

  • getTrafficClass(): number
  • Set the value of traffic class

    Returns number

isBroadcast

  • isBroadcast(): boolean
  • Set if the socket can send or receive broadcast packets

    Returns boolean

isIpV6

  • isIpV6(): boolean
  • Set if IP v6 should be used

    Returns boolean

isLoopbackModeDisabled

  • isLoopbackModeDisabled(): boolean
  • Set if loopback mode is disabled

    Returns boolean

isReuseAddress

  • isReuseAddress(): boolean
  • Set the value of reuse address

    Returns boolean

isReusePort

  • isReusePort(): boolean
  • Set the value of reuse port.

    This is only supported by native transports.

    Returns boolean

setActivityLogDataFormat

  • Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.

    Parameters

    • activityLogDataFormat: any

    Returns DatagramSocketOptions

setBroadcast

  • Set if the socket can send or receive broadcast packets

    Parameters

    • broadcast: boolean

    Returns DatagramSocketOptions

setIpV6

  • Set if IP v6 should be used

    Parameters

    • ipV6: boolean

    Returns DatagramSocketOptions

setLogActivity

  • Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    Parameters

    • logActivity: boolean

    Returns DatagramSocketOptions

setLoopbackModeDisabled

  • Set if loopback mode is disabled

    Parameters

    • loopbackModeDisabled: boolean

    Returns DatagramSocketOptions

setMulticastNetworkInterface

  • Set the multicast network interface address

    Parameters

    • multicastNetworkInterface: string

    Returns DatagramSocketOptions

setMulticastTimeToLive

  • Set the multicast ttl value

    Parameters

    • multicastTimeToLive: number

    Returns DatagramSocketOptions

setReceiveBufferSize

setReuseAddress

setReusePort

  • Set the value of reuse port.

    This is only supported by native transports.

    Parameters

    • reusePort: boolean

    Returns DatagramSocketOptions

setSendBufferSize

setTrafficClass

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc