Vert.x 4.5.13 · io.vertx.core.datagram.DatagramSocketOptions

Field Summary

Modifier and Type	Field and Description
private boolean	broadcast
public static final boolean	DEFAULT_BROADCAST The default value of broadcast for the socket = false
public static final boolean	DEFAULT_IPV6 The default value of use IP v6 = false
public static final boolean	DEFAULT_LOOPBACK_MODE_DISABLED The default value of loopback disabled = true
public static final String	DEFAULT_MULTICAST_NETWORK_INTERFACE The default value of multicast network interface = null
public static final int	DEFAULT_MULTICAST_TIME_TO_LIVE The default value of multicast disabled = -1
public static final boolean	DEFAULT_REUSE_ADDRESS Hides io.vertx.core.net.NetworkOptions.DEFAULT_REUSE_ADDRESS. The default value of reuse address = false
private boolean	ipV6
private boolean	loopbackModeDisabled
private String	multicastNetworkInterface
private int	multicastTimeToLive

Inherited from io.vertx.core.net.NetworkOptions:: DEFAULT_LOG_ACTIVITY_FORMAT DEFAULT_LOG_ENABLED DEFAULT_RECEIVE_BUFFER_SIZE DEFAULT_REUSE_PORT DEFAULT_SEND_BUFFER_SIZE DEFAULT_TRAFFIC_CLASS

Constructor Summary

Access	Constructor and Description
public	DatagramSocketOptions() Default constructor
public	DatagramSocketOptions(DatagramSocketOptions the options to copy other) Copy constructor
public	DatagramSocketOptions(JsonObject the JSON json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. Constructor to create options from JSON

Method Summary

Modifier and Type	Method and Description
public String	Returns: the interface address getMulticastNetworkInterface() Get the multicast network interface address
public int	Returns: the multicast ttl value getMulticastTimeToLive()
public int	getReceiveBufferSize() Overrides io.vertx.core.net.NetworkOptions.getReceiveBufferSize. Return the TCP receive buffer size, in bytes
public int	getSendBufferSize() Overrides io.vertx.core.net.NetworkOptions.getSendBufferSize. Return the TCP send buffer size, in bytes.
public int	getTrafficClass() Overrides io.vertx.core.net.NetworkOptions.getTrafficClass.
private void	init()
public boolean	Returns: true if the socket can send or receive broadcast packets? isBroadcast()
public boolean	Returns: true if IP v6 be used? isIpV6()
public boolean	Returns: true if loopback mode is disabled isLoopbackModeDisabled()
public DatagramSocketOptions	setActivityLogDataFormat(ByteBufFormat the format to use activityLogDataFormat) Overrides io.vertx.core.net.NetworkOptions.setActivityLogDataFormat. Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.
public DatagramSocketOptions	Returns: a reference to this, so the API can be used fluently setBroadcast(boolean true if the socket can send or receive broadcast packets broadcast) Set if the socket can send or receive broadcast packets
public DatagramSocketOptions	Returns: a reference to this, so the API can be used fluently setIpV6(boolean true if IP v6 should be used ipV6) Set if IP v6 should be used
public DatagramSocketOptions	setLogActivity(boolean true for logging the network activity logEnabled) Overrides io.vertx.core.net.NetworkOptions.setLogActivity. Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
public DatagramSocketOptions	Returns: a reference to this, so the API can be used fluently setLoopbackModeDisabled(boolean true if loopback mode is disabled loopbackModeDisabled) Set if loopback mode is disabled
public DatagramSocketOptions	Returns: a reference to this, so the API can be used fluently setMulticastNetworkInterface(String the address multicastNetworkInterface) Set the multicast network interface address
public DatagramSocketOptions	Returns: a reference to this, so the API can be used fluently setMulticastTimeToLive(int the multicast ttl value multicastTimeToLive) Set the multicast ttl value
public DatagramSocketOptions	setReceiveBufferSize(int the buffers size, in bytes receiveBufferSize) Overrides io.vertx.core.net.NetworkOptions.setReceiveBufferSize. Set the TCP receive buffer size
public DatagramSocketOptions	setReuseAddress(boolean the value of reuse address reuseAddress) Overrides io.vertx.core.net.NetworkOptions.setReuseAddress. Set the value of reuse address
public DatagramSocketOptions	setReusePort(boolean the value of reuse port reusePort) Overrides io.vertx.core.net.NetworkOptions.setReusePort. Set the value of reuse port.
public DatagramSocketOptions	setSendBufferSize(int the buffers size, in bytes sendBufferSize) Overrides io.vertx.core.net.NetworkOptions.setSendBufferSize. Set the TCP send buffer size
public DatagramSocketOptions	setTrafficClass(int the value of traffic class trafficClass) Overrides io.vertx.core.net.NetworkOptions.setTrafficClass. Set the value of traffic class

Inherited from io.vertx.core.net.NetworkOptions:: getActivityLogDataFormat getLogActivity isReuseAddress isReusePort toJson

Field Detail

broadcast	back to summary
private boolean broadcast

DEFAULT_BROADCAST	back to summary
public static final boolean DEFAULT_BROADCAST The default value of broadcast for the socket = false

DEFAULT_IPV6	back to summary
public static final boolean DEFAULT_IPV6 The default value of use IP v6 = false

DEFAULT_LOOPBACK_MODE_DISABLED	back to summary
public static final boolean DEFAULT_LOOPBACK_MODE_DISABLED The default value of loopback disabled = true

DEFAULT_MULTICAST_NETWORK_INTERFACE	back to summary
public static final String DEFAULT_MULTICAST_NETWORK_INTERFACE The default value of multicast network interface = null

DEFAULT_MULTICAST_TIME_TO_LIVE	back to summary
public static final int DEFAULT_MULTICAST_TIME_TO_LIVE The default value of multicast disabled = -1

DEFAULT_REUSE_ADDRESS	back to summary
public static final boolean DEFAULT_REUSE_ADDRESS Hides io.vertx.core.net.NetworkOptions.DEFAULT_REUSE_ADDRESS. The default value of reuse address = false

DEFAULT_REUSE_ADDRESS

back to summary

public static final boolean DEFAULT_REUSE_ADDRESS

Hides io.vertx.core.net.NetworkOptions.DEFAULT_REUSE_ADDRESS.

The default value of reuse address = false

ipV6	back to summary
private boolean ipV6

loopbackModeDisabled	back to summary
private boolean loopbackModeDisabled

multicastNetworkInterface	back to summary
private String multicastNetworkInterface

multicastTimeToLive	back to summary
private int multicastTimeToLive

Constructor Detail

DatagramSocketOptions	back to summary
public DatagramSocketOptions() Default constructor

DatagramSocketOptions	back to summary
public DatagramSocketOptions(DatagramSocketOptions other) Copy constructor Parameters other:DatagramSocketOptions the options to copy

DatagramSocketOptions

back to summary

public DatagramSocketOptions(DatagramSocketOptions other)

Copy constructor

Parameters

other:DatagramSocketOptions: the options to copy

DatagramSocketOptions back to summary

DatagramSocketOptions	back to summary
public DatagramSocketOptions(JsonObject json) References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Constructor to create options from JSON Parameters json:JsonObject the JSON

public DatagramSocketOptions(JsonObject json)

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructor to create options from JSON

Parameters

json:JsonObject: the JSON

Method Detail

getMulticastNetworkInterface	back to summary
public String getMulticastNetworkInterface() Get the multicast network interface address Returns:String the interface address

getMulticastNetworkInterface

back to summary

public String getMulticastNetworkInterface()

Get the multicast network interface address

Returns:String: the interface address

getMulticastTimeToLive	back to summary
public int getMulticastTimeToLive() Returns:int the multicast ttl value

getReceiveBufferSize	back to summary
public int getReceiveBufferSize() Overrides io.vertx.core.net.NetworkOptions.getReceiveBufferSize. Doc from io.vertx.core.net.NetworkOptions.getReceiveBufferSize. Return the TCP receive buffer size, in bytes Returns:int the receive buffer size Annotations @Override

getReceiveBufferSize

back to summary

public int getReceiveBufferSize()

Overrides io.vertx.core.net.NetworkOptions.getReceiveBufferSize.

Doc from io.vertx.core.net.NetworkOptions.getReceiveBufferSize.

Return the TCP receive buffer size, in bytes

Returns:int

the receive buffer size

Annotations

@Override

getSendBufferSize	back to summary
public int getSendBufferSize() Overrides io.vertx.core.net.NetworkOptions.getSendBufferSize. Doc from io.vertx.core.net.NetworkOptions.getSendBufferSize. Return the TCP send buffer size, in bytes. Returns:int the send buffer size Annotations @Override

getSendBufferSize

back to summary

public int getSendBufferSize()

Overrides io.vertx.core.net.NetworkOptions.getSendBufferSize.

Doc from io.vertx.core.net.NetworkOptions.getSendBufferSize.

Return the TCP send buffer size, in bytes.

Returns:int

the send buffer size

Annotations

@Override

getTrafficClass	back to summary
public int getTrafficClass() Overrides io.vertx.core.net.NetworkOptions.getTrafficClass. Returns:int Doc from io.vertx.core.net.NetworkOptions.getTrafficClass. the value of traffic class Annotations @Override

getTrafficClass

back to summary

public int getTrafficClass()

Overrides io.vertx.core.net.NetworkOptions.getTrafficClass.

Returns:int

Doc from io.vertx.core.net.NetworkOptions.getTrafficClass.

the value of traffic class

Annotations

@Override

init	back to summary
private void init()

isBroadcast	back to summary
public boolean isBroadcast() Returns:boolean true if the socket can send or receive broadcast packets?

isIpV6	back to summary
public boolean isIpV6() Returns:boolean true if IP v6 be used?

isLoopbackModeDisabled	back to summary
public boolean isLoopbackModeDisabled() Returns:boolean true if loopback mode is disabled

setActivityLogDataFormat	back to summary
public DatagramSocketOptions setActivityLogDataFormat(ByteBufFormat activityLogDataFormat) Overrides io.vertx.core.net.NetworkOptions.setActivityLogDataFormat. Doc from io.vertx.core.net.NetworkOptions.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:ByteBufFormat the format to use Returns:DatagramSocketOptions a reference to this, so the API can be used fluently Annotations @Override

setActivityLogDataFormat

back to summary

public DatagramSocketOptions setActivityLogDataFormat(ByteBufFormat activityLogDataFormat)

Overrides io.vertx.core.net.NetworkOptions.setActivityLogDataFormat.

Doc from io.vertx.core.net.NetworkOptions.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:ByteBufFormat: the format to use

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

Annotations

@Override

setBroadcast	back to summary
public DatagramSocketOptions setBroadcast(boolean broadcast) Set if the socket can send or receive broadcast packets Parameters broadcast:boolean true if the socket can send or receive broadcast packets Returns:DatagramSocketOptions a reference to this, so the API can be used fluently

setBroadcast

back to summary

public DatagramSocketOptions setBroadcast(boolean broadcast)

Set if the socket can send or receive broadcast packets

Parameters

broadcast:boolean: true if the socket can send or receive broadcast packets

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

setIpV6	back to summary
public DatagramSocketOptions setIpV6(boolean ipV6) Set if IP v6 should be used Parameters ipV6:boolean true if IP v6 should be used Returns:DatagramSocketOptions a reference to this, so the API can be used fluently

setIpV6

back to summary

public DatagramSocketOptions setIpV6(boolean ipV6)

Set if IP v6 should be used

Parameters

ipV6:boolean: true if IP v6 should be used

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

setLogActivity	back to summary
public DatagramSocketOptions setLogActivity(boolean logEnabled) Overrides io.vertx.core.net.NetworkOptions.setLogActivity. Doc from io.vertx.core.net.NetworkOptions.setLogActivity. Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. Parameters logEnabled:boolean true for logging the network activity Returns:DatagramSocketOptions a reference to this, so the API can be used fluently Annotations @Override

setLogActivity

back to summary

public DatagramSocketOptions setLogActivity(boolean logEnabled)

Overrides io.vertx.core.net.NetworkOptions.setLogActivity.

Doc from io.vertx.core.net.NetworkOptions.setLogActivity.

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

Parameters

logEnabled:boolean: true for logging the network activity

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

Annotations

@Override

setLoopbackModeDisabled	back to summary
public DatagramSocketOptions setLoopbackModeDisabled(boolean loopbackModeDisabled) Set if loopback mode is disabled Parameters loopbackModeDisabled:boolean true if loopback mode is disabled Returns:DatagramSocketOptions a reference to this, so the API can be used fluently

setLoopbackModeDisabled

back to summary

public DatagramSocketOptions setLoopbackModeDisabled(boolean loopbackModeDisabled)

Set if loopback mode is disabled

Parameters

loopbackModeDisabled:boolean: true if loopback mode is disabled

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

setMulticastNetworkInterface	back to summary
public DatagramSocketOptions setMulticastNetworkInterface(String multicastNetworkInterface) Set the multicast network interface address Parameters multicastNetworkInterface:String the address Returns:DatagramSocketOptions a reference to this, so the API can be used fluently

setMulticastNetworkInterface

back to summary

public DatagramSocketOptions setMulticastNetworkInterface(String multicastNetworkInterface)

Set the multicast network interface address

Parameters

multicastNetworkInterface:String: the address

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

setMulticastTimeToLive	back to summary
public DatagramSocketOptions setMulticastTimeToLive(int multicastTimeToLive) Set the multicast ttl value Parameters multicastTimeToLive:int the multicast ttl value Returns:DatagramSocketOptions a reference to this, so the API can be used fluently

setMulticastTimeToLive

back to summary

public DatagramSocketOptions setMulticastTimeToLive(int multicastTimeToLive)

Set the multicast ttl value

Parameters

multicastTimeToLive:int: the multicast ttl value

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

setReceiveBufferSize	back to summary
public DatagramSocketOptions setReceiveBufferSize(int receiveBufferSize) Overrides io.vertx.core.net.NetworkOptions.setReceiveBufferSize. Doc from io.vertx.core.net.NetworkOptions.setReceiveBufferSize. Set the TCP receive buffer size Parameters receiveBufferSize:int the buffers size, in bytes Returns:DatagramSocketOptions a reference to this, so the API can be used fluently Annotations @Override

setReceiveBufferSize

back to summary

public DatagramSocketOptions setReceiveBufferSize(int receiveBufferSize)

Overrides io.vertx.core.net.NetworkOptions.setReceiveBufferSize.

Doc from io.vertx.core.net.NetworkOptions.setReceiveBufferSize.

Set the TCP receive buffer size

Parameters

receiveBufferSize:int: the buffers size, in bytes

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

Annotations

@Override

setReuseAddress	back to summary
public DatagramSocketOptions setReuseAddress(boolean reuseAddress) Overrides io.vertx.core.net.NetworkOptions.setReuseAddress. Doc from io.vertx.core.net.NetworkOptions.setReuseAddress. Set the value of reuse address Parameters reuseAddress:boolean the value of reuse address Returns:DatagramSocketOptions a reference to this, so the API can be used fluently Annotations @Override

setReuseAddress

back to summary

public DatagramSocketOptions setReuseAddress(boolean reuseAddress)

Overrides io.vertx.core.net.NetworkOptions.setReuseAddress.

Doc from io.vertx.core.net.NetworkOptions.setReuseAddress.

Set the value of reuse address

Parameters

reuseAddress:boolean: the value of reuse address

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

Annotations

@Override

setReusePort	back to summary
public DatagramSocketOptions setReusePort(boolean reusePort) Overrides io.vertx.core.net.NetworkOptions.setReusePort. Doc from io.vertx.core.net.NetworkOptions.setReusePort. Set the value of reuse port. This is only supported by native transports. Parameters reusePort:boolean the value of reuse port Returns:DatagramSocketOptions a reference to this, so the API can be used fluently Annotations @Override

setReusePort

back to summary

public DatagramSocketOptions setReusePort(boolean reusePort)

Overrides io.vertx.core.net.NetworkOptions.setReusePort.

Doc from io.vertx.core.net.NetworkOptions.setReusePort.

Set the value of reuse port.

This is only supported by native transports.

Parameters

reusePort:boolean: the value of reuse port

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

Annotations

@Override

setSendBufferSize	back to summary
public DatagramSocketOptions setSendBufferSize(int sendBufferSize) Overrides io.vertx.core.net.NetworkOptions.setSendBufferSize. Doc from io.vertx.core.net.NetworkOptions.setSendBufferSize. Set the TCP send buffer size Parameters sendBufferSize:int the buffers size, in bytes Returns:DatagramSocketOptions a reference to this, so the API can be used fluently Annotations @Override

setSendBufferSize

back to summary

public DatagramSocketOptions setSendBufferSize(int sendBufferSize)

Overrides io.vertx.core.net.NetworkOptions.setSendBufferSize.

Doc from io.vertx.core.net.NetworkOptions.setSendBufferSize.

Set the TCP send buffer size

Parameters

sendBufferSize:int: the buffers size, in bytes

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

Annotations

@Override

setTrafficClass	back to summary
public DatagramSocketOptions setTrafficClass(int trafficClass) Overrides io.vertx.core.net.NetworkOptions.setTrafficClass. Doc from io.vertx.core.net.NetworkOptions.setTrafficClass. Set the value of traffic class Parameters trafficClass:int the value of traffic class Returns:DatagramSocketOptions a reference to this, so the API can be used fluently Annotations @Override

setTrafficClass

back to summary

public DatagramSocketOptions setTrafficClass(int trafficClass)

Overrides io.vertx.core.net.NetworkOptions.setTrafficClass.

Doc from io.vertx.core.net.NetworkOptions.setTrafficClass.

Set the value of traffic class

Parameters

trafficClass:int: the value of traffic class

Returns:DatagramSocketOptions

a reference to this, so the API can be used fluently

Annotations

@Override

public Class DatagramSocketOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail