Vert.x 4.5.13 · io.vertx.core.net.NetworkOptions · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private ByteBufFormat	activityLogDataFormat
public static final ByteBufFormat	DEFAULT_LOG_ACTIVITY_FORMAT The default logActivity is ByteBufFormat.SIMPLE
public static final boolean	DEFAULT_LOG_ENABLED The default log enabled = false
public static final int	DEFAULT_RECEIVE_BUFFER_SIZE The default value of TCP receive buffer size
public static final boolean	DEFAULT_REUSE_ADDRESS The default value of reuse address
public static final boolean	DEFAULT_REUSE_PORT The default value of reuse port
public static final int	DEFAULT_SEND_BUFFER_SIZE The default value of TCP send buffer size
public static final int	DEFAULT_TRAFFIC_CLASS The default value of traffic class
private boolean	logActivity
private int	receiveBufferSize
private boolean	reuseAddress
private boolean	reusePort
private int	sendBufferSize
private int	trafficClass

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public ByteBufFormat	Returns: Netty's logging handler's data format. getActivityLogDataFormat()
public boolean	Returns: true when network activity logging is enabled getLogActivity()
public int	Returns: the receive buffer size getReceiveBufferSize() Return the TCP receive buffer size, in bytes
public int	Returns: the send buffer size getSendBufferSize() Return the TCP send buffer size, in bytes.
public int	Returns: the value of traffic class getTrafficClass()
public boolean	Returns: the value of reuse address isReuseAddress()
public boolean	Returns: the value of reuse address - only supported by native transports isReusePort()
public NetworkOptions	Returns: a reference to this, so the API can be used fluently setActivityLogDataFormat(ByteBufFormat the format to use activityLogDataFormat) Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.
public NetworkOptions	Returns: a reference to this, so the API can be used fluently setLogActivity(boolean true for logging the network activity logActivity) Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
public NetworkOptions	Returns: a reference to this, so the API can be used fluently setReceiveBufferSize(int the buffers size, in bytes receiveBufferSize) Set the TCP receive buffer size
public NetworkOptions	Returns: a reference to this, so the API can be used fluently setReuseAddress(boolean the value of reuse address reuseAddress) Set the value of reuse address
public NetworkOptions	Returns: a reference to this, so the API can be used fluently setReusePort(boolean the value of reuse port reusePort) Set the value of reuse port.
public NetworkOptions	Returns: a reference to this, so the API can be used fluently setSendBufferSize(int the buffers size, in bytes sendBufferSize) Set the TCP send buffer size
public NetworkOptions	Returns: a reference to this, so the API can be used fluently setTrafficClass(int the value of traffic class trafficClass) Set the value of traffic class
public JsonObject	Returns: the JSON toJson() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. Convert to JSON

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

activityLogDataFormat	back to summary
private ByteBufFormat activityLogDataFormat

DEFAULT_LOG_ACTIVITY_FORMAT	back to summary
public static final ByteBufFormat DEFAULT_LOG_ACTIVITY_FORMAT The default logActivity is ByteBufFormat.SIMPLE

DEFAULT_LOG_ENABLED	back to summary
public static final boolean DEFAULT_LOG_ENABLED The default log enabled = false

DEFAULT_RECEIVE_BUFFER_SIZE	back to summary
public static final int DEFAULT_RECEIVE_BUFFER_SIZE The default value of TCP receive buffer size

DEFAULT_REUSE_ADDRESS	back to summary
public static final boolean DEFAULT_REUSE_ADDRESS The default value of reuse address

DEFAULT_REUSE_PORT	back to summary
public static final boolean DEFAULT_REUSE_PORT The default value of reuse port

DEFAULT_SEND_BUFFER_SIZE	back to summary
public static final int DEFAULT_SEND_BUFFER_SIZE The default value of TCP send buffer size

DEFAULT_TRAFFIC_CLASS	back to summary
public static final int DEFAULT_TRAFFIC_CLASS The default value of traffic class

logActivity	back to summary
private boolean logActivity

receiveBufferSize	back to summary
private int receiveBufferSize

reuseAddress	back to summary
private boolean reuseAddress

reusePort	back to summary
private boolean reusePort

sendBufferSize	back to summary
private int sendBufferSize

trafficClass	back to summary
private int trafficClass

Constructor Detail

NetworkOptions	back to summary
public NetworkOptions() Default constructor

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

NetworkOptions

back to summary

public NetworkOptions(NetworkOptions other)

Copy constructor

Parameters

other:NetworkOptions: the options to copy

NetworkOptions back to summary

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

public NetworkOptions(JsonObject json)

References Deprecated

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

See corresponding docs for further information.

Constructor from JSON

Parameters

json:JsonObject: the JSON

Method Detail

getActivityLogDataFormat	back to summary
public ByteBufFormat getActivityLogDataFormat() Returns:ByteBufFormat Netty's logging handler's data format. Annotations @Unstable

getLogActivity	back to summary
public boolean getLogActivity() Returns:boolean true when network activity logging is enabled

getReceiveBufferSize	back to summary
public int getReceiveBufferSize() Return the TCP receive buffer size, in bytes Returns:int the receive buffer size

getReceiveBufferSize

back to summary

public int getReceiveBufferSize()

Return the TCP receive buffer size, in bytes

Returns:int: the receive buffer size

getSendBufferSize	back to summary
public int getSendBufferSize() Return the TCP send buffer size, in bytes. Returns:int the send buffer size

getSendBufferSize

back to summary

public int getSendBufferSize()

Return the TCP send buffer size, in bytes.

Returns:int: the send buffer size

getTrafficClass	back to summary
public int getTrafficClass() Returns:int the value of traffic class

isReuseAddress	back to summary
public boolean isReuseAddress() Returns:boolean the value of reuse address

isReusePort	back to summary
public boolean isReusePort() Returns:boolean the value of reuse address - only supported by native transports

setActivityLogDataFormat	back to summary
public NetworkOptions setActivityLogDataFormat(ByteBufFormat activityLogDataFormat) 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:NetworkOptions a reference to this, so the API can be used fluently Annotations @Unstable

setActivityLogDataFormat

back to summary

public NetworkOptions setActivityLogDataFormat(ByteBufFormat activityLogDataFormat)

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:NetworkOptions

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

Annotations

@Unstable

setLogActivity	back to summary
public NetworkOptions setLogActivity(boolean logActivity) Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. Parameters logActivity:boolean true for logging the network activity Returns:NetworkOptions a reference to this, so the API can be used fluently

setLogActivity

back to summary

public NetworkOptions setLogActivity(boolean logActivity)

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

Parameters

logActivity:boolean: true for logging the network activity

Returns:NetworkOptions

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

setReceiveBufferSize	back to summary
public NetworkOptions setReceiveBufferSize(int receiveBufferSize) Set the TCP receive buffer size Parameters receiveBufferSize:int the buffers size, in bytes Returns:NetworkOptions a reference to this, so the API can be used fluently

setReceiveBufferSize

back to summary

public NetworkOptions setReceiveBufferSize(int receiveBufferSize)

Set the TCP receive buffer size

Parameters

receiveBufferSize:int: the buffers size, in bytes

Returns:NetworkOptions

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

setReuseAddress	back to summary
public NetworkOptions setReuseAddress(boolean reuseAddress) Set the value of reuse address Parameters reuseAddress:boolean the value of reuse address Returns:NetworkOptions a reference to this, so the API can be used fluently

setReuseAddress

back to summary

public NetworkOptions setReuseAddress(boolean reuseAddress)

Set the value of reuse address

Parameters

reuseAddress:boolean: the value of reuse address

Returns:NetworkOptions

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

setReusePort	back to summary
public NetworkOptions setReusePort(boolean reusePort) Set the value of reuse port. This is only supported by native transports. Parameters reusePort:boolean the value of reuse port Returns:NetworkOptions a reference to this, so the API can be used fluently

setReusePort

back to summary

public NetworkOptions setReusePort(boolean reusePort)

Set the value of reuse port.

This is only supported by native transports.

Parameters

reusePort:boolean: the value of reuse port

Returns:NetworkOptions

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

setSendBufferSize	back to summary
public NetworkOptions setSendBufferSize(int sendBufferSize) Set the TCP send buffer size Parameters sendBufferSize:int the buffers size, in bytes Returns:NetworkOptions a reference to this, so the API can be used fluently

setSendBufferSize

back to summary

public NetworkOptions setSendBufferSize(int sendBufferSize)

Set the TCP send buffer size

Parameters

sendBufferSize:int: the buffers size, in bytes

Returns:NetworkOptions

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

setTrafficClass	back to summary
public NetworkOptions setTrafficClass(int trafficClass) Set the value of traffic class Parameters trafficClass:int the value of traffic class Returns:NetworkOptions a reference to this, so the API can be used fluently

setTrafficClass

back to summary

public NetworkOptions setTrafficClass(int trafficClass)

Set the value of traffic class

Parameters

trafficClass:int: the value of traffic class

Returns:NetworkOptions

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

toJson back to summary

toJson	back to summary
public JsonObject toJson() References Deprecated `JsonObject` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Convert to JSON Returns:JsonObject the JSON

public JsonObject toJson()

References Deprecated

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

See corresponding docs for further information.

Convert to JSON

Returns:JsonObject: the JSON

public abstract Class NetworkOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail