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.

Wiki & Forum:

Wiki
Forum

Method Summary

int	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.
int	getMaxOpenClients() Gets maximum count of simultaneously open TCP clients for one remote node.
int	getMessageThreads() Gets number of threads used for handling NIO messages.
int	getNioActiveThreadCount() Returns the approximate number of threads that are actively processing NIO tasks.
int	getNioCorePoolSize() Returns the core number of NIO threads.
int	getNioLargestPoolSize() Returns the largest number of NIO threads that have ever simultaneously been in the pool.
int	getNioMaximumPoolSize() Returns the maximum allowed number of NIO threads.
int	getNioPoolSize() Returns the current number of NIO threads in the pool.
int	getNioTaskQueueSize() Gets current size of the NIO queue size.
long	getNioTotalCompletedTaskCount() Returns the approximate total number of NIO tasks that have completed execution.
long	getNioTotalScheduledTaskCount() Returns the approximate total number of NIO tasks that have been scheduled for execution.
long	getReceivedBytesCount() Gets received bytes count.
int	getReceivedMessagesCount() Gets received messages count.
int	getSelectorsCount() Gets count of selectors used in TCP server.
long	getSentBytesCount() Gets sent bytes count.
int	getSentMessagesCount() Gets sent messages count.
GridSpiPortResolver	getSpiPortResolver() Gets port resolver for ports mapping determination.
boolean	isDirectBuffer() Gets flag that indicates whether direct or heap allocated buffer is used.

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

getAuthor, getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, getVendorEmail, getVendorUrl, getVersion

Method Detail

getNioActiveThreadCount

@GridMBeanDescription(value="Approximate number of threads that are actively processing NIO tasks.")
int getNioActiveThreadCount()

Returns the approximate number of threads that are actively processing NIO tasks.

Returns:

Approximate number of threads that are actively processing NIO tasks.

getNioTotalCompletedTaskCount

@GridMBeanDescription(value="Approximate total number of NIO tasks that have completed execution.")
long getNioTotalCompletedTaskCount()

Returns the approximate total number of NIO tasks that have completed execution. Because the states of tasks and threads may change dynamically during computation, the returned value is only an approximation, but one that does not ever decrease across successive calls.

Returns:

Approximate total number of NIO tasks that have completed execution.

getNioTaskQueueSize

@GridMBeanDescription(value="Current size of the NIO queue size.")
int getNioTaskQueueSize()

Gets current size of the NIO queue size. NIO queue buffers NIO tasks when there are not threads available for processing in the pool.

Returns:

Current size of the NIO queue size.

getNioCorePoolSize

@GridMBeanDescription(value="Core number of NIO threads.")
int getNioCorePoolSize()

Returns the core number of NIO threads.

Returns:

Core number of NIO threads.

getNioLargestPoolSize

@GridMBeanDescription(value="Largest number of NIO threads that have ever simultaneously been in the pool.")
int getNioLargestPoolSize()

Returns the largest number of NIO threads that have ever simultaneously been in the pool.

Returns:

Largest number of NIO threads that have ever simultaneously been in the pool.

getNioMaximumPoolSize

@GridMBeanDescription(value="Maximum allowed number of NIO threads.")
int getNioMaximumPoolSize()

Returns the maximum allowed number of NIO threads.

Returns:

Maximum allowed number of NIO threads.

getNioPoolSize

@GridMBeanDescription(value="Current number of NIO threads in the pool.")
int getNioPoolSize()

Returns the current number of NIO threads in the pool.

Returns:

Current number of NIO threads in the pool.

getNioTotalScheduledTaskCount

@GridMBeanDescription(value="Approximate total number of NIO tasks that have been scheduled for execution.")
long getNioTotalScheduledTaskCount()

Returns the approximate total number of NIO tasks that have been scheduled for execution. Because the states of tasks and threads may change dynamically during computation, the returned value is only an approximation, but one that does not ever decrease across successive calls.

Returns:

Approximate total number of NIO tasks that have been scheduled for execution.

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.

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.

getMaxOpenClients

@GridMBeanDescription(value="Maximum count of simultaneously open clients for one remote node.")
int getMaxOpenClients()

Gets maximum count of simultaneously open TCP clients for one remote node.

Returns:

Maximum count of open TCP clients per node.

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.

getMessageThreads

@GridMBeanDescription(value="Number of threads used for handling NIO messages.")
int getMessageThreads()

Gets number of threads used for handling NIO messages.

Returns:

Number of threads used for handling NIO 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.

getSpiPortResolver

@GridMBeanDescription(value="Port resolver for ports mapping determination.")
GridSpiPortResolver getSpiPortResolver()

Gets port resolver for ports mapping determination.

Returns:

Port resolver for ports mapping determination.

getConnectTimeout

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

Gets connect timeout used when establishing connection with remote nodes.

Returns:

Connect timeout.