org.gridgain.grid.spi.communication.tcp

Interface GridTcpCommunicationSpiMBean

All Superinterfaces:

GridSpiManagementMBean

All Known Implementing Classes:

GridTcpCommunicationSpi

@GridMBeanDescription(value="MBean provide access to TCP-based communication SPI.")
public interface GridTcpCommunicationSpiMBean
extends GridSpiManagementMBean

MBean provide access to TCP-based communication SPI.

Method Summary

Methods

Modifier and Type	Method and Description
double	getBufferSizeRatio() Gets the buffer size ratio for this SPI.
long	getConnectionBufferFlushFrequency() Gets connection buffer flush frequency.
int	getConnectionBufferSize() Gets connection buffer size.
long	getConnectTimeout() Gets connect timeout used when establishing connection with remote nodes.
long	getIdleConnectionTimeout() Gets maximum idle connection time upon which idle connections will be closed.
String	getLocalAddress() Gets local host address for socket binding.
int	getLocalPort() Gets local port for socket binding.
int	getLocalPortRange() Gets maximum number of local ports tried if all previously tried ports are occupied.
long	getMaxConnectTimeout() Gets maximum connect timeout.
int	getMessageQueueLimit() Gets message queue limit for incoming and outgoing messages.
int	getMinimumBufferedMessageCount() Gets the minimum number of messages for this SPI, that are buffered prior to sending.
int	getOutboundMessagesQueueSize() Gets outbound messages queue size.
long	getReceivedBytesCount() Gets received bytes count.
int	getReceivedMessagesCount() Gets received messages count.
int	getReconnectCount() Gets maximum number of reconnect attempts used when establishing connection with remote nodes.
int	getSelectorsCount() Gets count of selectors used in TCP server.
long	getSentBytesCount() Gets sent bytes count.
int	getSentMessagesCount() Gets sent messages count.
int	getSharedMemoryPort() Gets local port for shared memory communication.
int	getSocketReceiveBuffer() Gets receive buffer size for sockets created or accepted by this SPI.
int	getSocketSendBuffer() Gets send buffer size for sockets created or accepted by this SPI.
boolean	isAsyncSend() Gets flag defining whether asynchronous (NIO) or synchronous (blocking) IO should be used to send messages.
boolean	isDirectBuffer() Gets flag that indicates whether direct or heap allocated buffer is used.
boolean	isDirectSendBuffer() Gets flag defining whether direct send buffer should be used.
boolean	isDualSocketConnection() Gets flag indicating whether dual-socket connection between nodes should be enforced.
boolean	isTcpNoDelay() Gets value for TCP_NODELAY socket option.
void	setConnectionBufferFlushFrequency(long connBufFlushFreq) Sets connection buffer flush frequency.

Methods inherited from interface org.gridgain.grid.spi.GridSpiManagementMBean

getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted

Method Detail

getLocalAddress

@GridMBeanDescription(value="Grid node IP address.")
String getLocalAddress()

Gets local host address for socket binding. Beside loopback address physical node could have several other ones, but only one is assigned to grid node.

Returns:

Grid node IP address.

getLocalPort

@GridMBeanDescription(value="Port number.")
int getLocalPort()

Gets local port for socket binding.

Returns:

Port number.

getSharedMemoryPort

@GridMBeanDescription(value="Shared memory endpoint port number.")
int getSharedMemoryPort()

Gets local port for shared memory communication.

Returns:

Port number.

getLocalPortRange

@GridMBeanDescription(value="Local port range.")
int getLocalPortRange()

Gets maximum number of local ports tried if all previously tried ports are occupied.

Returns:

Local port range.

getIdleConnectionTimeout

@GridMBeanDescription(value="Maximum idle connection time.")
long getIdleConnectionTimeout()

Gets maximum idle connection time upon which idle connections will be closed.

Returns:

Maximum idle connection time.

isDirectBuffer

@GridMBeanDescription(value="Flag that indicates whether direct or heap allocated buffer is used.")
boolean isDirectBuffer()

Gets flag that indicates whether direct or heap allocated buffer is used.

Returns:

Flag that indicates whether direct or heap allocated buffer is used.

getSelectorsCount

@GridMBeanDescription(value="Count of selectors used in TCP server.")
int getSelectorsCount()

Gets count of selectors used in TCP server. Default value equals to the number of CPUs available in the system.

Returns:

Count of selectors in TCP server.

isAsyncSend

@GridMBeanDescription(value="Asynchronous send.")
boolean isAsyncSend()

Gets flag defining whether asynchronous (NIO) or synchronous (blocking) IO should be used to send messages.

Returns:

True if asynchronous IO should be used to send messages.

getSentMessagesCount

@GridMBeanDescription(value="Sent messages count.")
int getSentMessagesCount()

Gets sent messages count.

Returns:

Sent messages count.

getSentBytesCount

@GridMBeanDescription(value="Sent bytes count.")
long getSentBytesCount()

Gets sent bytes count.

Returns:

Sent bytes count.

getReceivedMessagesCount

@GridMBeanDescription(value="Received messages count.")
int getReceivedMessagesCount()

Gets received messages count.

Returns:

Received messages count.

getReceivedBytesCount

@GridMBeanDescription(value="Received bytes count.")
long getReceivedBytesCount()

Gets received bytes count.

Returns:

Received bytes count.

getOutboundMessagesQueueSize

@GridMBeanDescription(value="Outbound messages queue size.")
int getOutboundMessagesQueueSize()

Gets outbound messages queue size.

Returns:

Outbound messages queue size.

getConnectTimeout

@GridMBeanDescription(value="Connect timeout.")
long getConnectTimeout()

Gets connect timeout used when establishing connection with remote nodes.

Returns:

Connect timeout.

getMaxConnectTimeout

@GridMBeanDescription(value="Maximum connect timeout.")
long getMaxConnectTimeout()

Gets maximum connect timeout.

Returns:

Maximum connect timeout.

getReconnectCount

@GridMBeanDescription(value="Reconnect count on connection failure.")
int getReconnectCount()

Gets maximum number of reconnect attempts used when establishing connection with remote nodes.

Returns:

Reconnects count.

isTcpNoDelay

@GridMBeanDescription(value="TCP_NODELAY socket option value.")
boolean isTcpNoDelay()

Gets value for TCP_NODELAY socket option.

Returns:

True if TCP delay is disabled.

getConnectionBufferFlushFrequency

@GridMBeanDescription(value="Connection buffer flush frequency.")
long getConnectionBufferFlushFrequency()

Gets connection buffer flush frequency.

Client connections to other nodes in topology use buffered output. This frequency defines how often system will advice to flush connection buffer.

Returns:

Flush frequency.

setConnectionBufferFlushFrequency

@GridMBeanDescription(value="Sets connection buffer flush frequency.")
void setConnectionBufferFlushFrequency(long connBufFlushFreq)

Sets connection buffer flush frequency.

Client connections to other nodes in topology use buffered output. This frequency defines how often system will advice to flush connection buffer.

If not provided, default value is GridTcpCommunicationSpi.DFLT_CONN_BUF_FLUSH_FREQ.

This property is used only if getConnectionBufferSize() is greater than 0.

Parameters:

connBufFlushFreq - Flush frequency.

See Also:

getConnectionBufferSize()

getConnectionBufferSize

@GridMBeanDescription(value="Connection buffer size.")
int getConnectionBufferSize()

Gets connection buffer size.

If set to 0 connection buffer is disabled.

Returns:

Connection buffer size.

isDirectSendBuffer

@GridMBeanDescription(value="Direct send buffer.")
boolean isDirectSendBuffer()

Gets flag defining whether direct send buffer should be used.

Returns:

True if direct buffers should be used.

getSocketReceiveBuffer

@GridMBeanDescription(value="Socket receive buffer.")
int getSocketReceiveBuffer()

Gets receive buffer size for sockets created or accepted by this SPI.

If not provided, default is GridTcpCommunicationSpi.DFLT_SOCK_BUF_SIZE.

Returns:

Socket receive buffer size.

getSocketSendBuffer

@GridMBeanDescription(value="Socket send buffer.")
int getSocketSendBuffer()

Gets send buffer size for sockets created or accepted by this SPI.

If not provided, default is GridTcpCommunicationSpi.DFLT_SOCK_BUF_SIZE.

Returns:

Socket send buffer size.

isDualSocketConnection

@GridMBeanDescription(value="Dual-socket connection.")
boolean isDualSocketConnection()

Gets flag indicating whether dual-socket connection between nodes should be enforced. If set to true, two separate connections will be established between communicating nodes: one for outgoing messages, and one for incoming. When set to false, single TCP connection will be used for both directions.

This flag is useful on some operating systems, when TCP_NODELAY flag is disabled and messages take too long to get delivered.

Returns:

Whether dual-socket connection should be enforced.

getMessageQueueLimit

@GridMBeanDescription(value="Message queue size limit.")
int getMessageQueueLimit()

Gets message queue limit for incoming and outgoing messages.

This parameter only used when isAsyncSend() set to true.

Returns:

Send queue size limit.

getMinimumBufferedMessageCount

@GridMBeanDescription(value="Minimum buffered message count.")
int getMinimumBufferedMessageCount()

Gets the minimum number of messages for this SPI, that are buffered prior to sending.

Returns:

Minimum buffered message count.

getBufferSizeRatio

@GridMBeanDescription(value="Buffer size ratio.")
double getBufferSizeRatio()

Gets the buffer size ratio for this SPI. As messages are sent, the buffer size is adjusted using this ratio.

Returns:

Buffer size ratio.