org.apache.ignite.spi.discovery.tcp

## Interface TcpDiscoverySpiMBean

- All Superinterfaces:
    DiscoverySpiMBean, IgniteSpiManagementMBean

      @MXBeanDescription(value="MBean provide access to TCP-based discovery SPI.")
      public interface TcpDiscoverySpiMBean
      extends IgniteSpiManagementMBean, DiscoverySpiMBean

  Management bean for `TcpDiscoverySpi`.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `checkRingLatency(int maxHops)` Diagnosis method for determining ring message latency.
    `void` | `dumpDebugInfo()` Dumps debug info using configured logger.
    `void` | `dumpRingStructure()` Dumps ring structure to log.
    `long` | `getAckTimeout()` Gets message acknowledgement timeout.
    `long` | `getAvgMessageProcessingTime()` Gets avg message processing time.
    `long` | `getConnectionCheckInterval()` Gets connection check interval in ms.
    `@Nullable UUID` | `getCoordinator()` Gets current coordinator.
    `long` | `getCoordinatorSinceTimestamp()` Gets time local node has been coordinator since.
    `long` | `getCurrentTopologyVersion()` Current topology version.
    `long` | `getIpFinderCleanFrequency()` Gets frequency with which coordinator cleans IP finder and keeps it in the correct state, unregistering addresses of the nodes that have left the topology.
    `String` | `getIpFinderFormatted()` Gets `TcpDiscoveryIpFinder` (string representation).
    `long` | `getJoinTimeout()` The join timeout, in milliseconds.
    `int` | `getLocalPort()` Gets local TCP port SPI listens to.
    `int` | `getLocalPortRange()` Gets local TCP port range.
    `long` | `getMaxAckTimeout()` Gets maximum message acknowledgement timeout.
    `long` | `getMaxMessageProcessingTime()` Gets max message processing time.
    `int` | `getMessageWorkerQueueSize()` Gets message worker queue current size.
    `long` | `getNetworkTimeout()` Gets network timeout.
    `long` | `getNodesFailed()` Gets failed nodes count.
    `long` | `getNodesJoined()` Gets joined nodes count.
    `long` | `getNodesLeft()` Gets left nodes count.
    `long` | `getPendingMessagesDiscarded()` Gets pending messages discarded count.
    `long` | `getPendingMessagesRegistered()` Gets pending messages registered count.
    `Map<String,Integer>` | `getProcessedMessages()` Gets processed messages counts (grouped by type).
    `Map<String,Integer>` | `getReceivedMessages()` Gets received messages counts (grouped by type).
    `int` | `getReconnectCount()` Gets number of connection attempts.
    `long` | `getSocketTimeout()` Gets socket timeout.
    `String` | `getSpiState()` Gets current SPI state.
    `long` | `getStatisticsPrintFrequency()` Gets statistics print frequency.
    `int` | `getThreadPriority()` Gets thread priority.
    `int` | `getTotalProcessedMessages()` Gets total processed messages count.
    `int` | `getTotalReceivedMessages()` Gets total received messages count.
    `boolean` | `isClientMode()` Whether or not discovery is started in client mode.

    - ### Methods inherited from interface org.apache.ignite.spi.IgniteSpiManagementMBean

      `getIgniteHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted`

    - ### Methods inherited from interface org.apache.ignite.spi.discovery.DiscoverySpiMBean

      `excludeNode, getCoordinatorNodeFormatted, getLocalNodeFormatted`

- - ### Method Detail

    - #### getSpiState

          @MXBeanDescription(value="SPI state.")
          String getSpiState()

      Gets current SPI state.
      Specified by:
        `getSpiState` in interface `DiscoverySpiMBean`
      Returns:
        Current SPI state.

    - #### getIpFinderFormatted

          @MXBeanDescription(value="IP Finder.")
          String getIpFinderFormatted()

      Gets `TcpDiscoveryIpFinder` (string representation).
      Returns:
        IPFinder (string representation).

    - #### getReconnectCount

          @MXBeanDescription(value="Reconnect count.")
          int getReconnectCount()

      Gets number of connection attempts.
      Returns:
        Number of connection attempts.

    - #### getConnectionCheckInterval

          @MXBeanDescription(value="Connection check interval.")
          long getConnectionCheckInterval()

      Gets connection check interval in ms.
      Returns:
        Connection check interval.

    - #### getNetworkTimeout

          @MXBeanDescription(value="Network timeout.")
          long getNetworkTimeout()

      Gets network timeout.
      Returns:
        Network timeout.

    - #### getLocalPort

          @MXBeanDescription(value="Local TCP port.")
          int getLocalPort()

      Gets local TCP port SPI listens to.
      Returns:
        Local port range.

    - #### getLocalPortRange

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

      Gets local TCP port range.
      Returns:
        Local port range.

    - #### getThreadPriority

          @MXBeanDescription(value="Threads priority.")
          int getThreadPriority()

      Gets thread priority. All threads within SPI will be started with it.
      Returns:
        Thread priority.

    - #### getIpFinderCleanFrequency

          @MXBeanDescription(value="The frequency with which coordinator cleans IP finder and keeps it in the correct state, unregistering addresses of the nodes that have left the topology.")
          long getIpFinderCleanFrequency()

      Gets frequency with which coordinator cleans IP finder and keeps it in the correct state, unregistering addresses of the nodes that have left the topology.
      Returns:
        IP finder clean frequency.

    - #### getStatisticsPrintFrequency

          @MXBeanDescription(value="Statistics print frequency.")
          long getStatisticsPrintFrequency()

      Gets statistics print frequency.
      Returns:
        Statistics print frequency in milliseconds.

    - #### getMessageWorkerQueueSize

          @MXBeanDescription(value="Message worker queue current size.")
          int getMessageWorkerQueueSize()

      Gets message worker queue current size.
      Returns:
        Message worker queue current size.

    - #### getNodesJoined

          @MXBeanDescription(value="Nodes joined count.")
          long getNodesJoined()

      Gets joined nodes count.
      Specified by:
        `getNodesJoined` in interface `DiscoverySpiMBean`
      Returns:
        Nodes joined count.

    - #### getNodesLeft

          @MXBeanDescription(value="Nodes left count.")
          long getNodesLeft()

      Gets left nodes count.
      Specified by:
        `getNodesLeft` in interface `DiscoverySpiMBean`
      Returns:
        Left nodes count.

    - #### getNodesFailed

          @MXBeanDescription(value="Nodes failed count.")
          long getNodesFailed()

      Gets failed nodes count.
      Specified by:
        `getNodesFailed` in interface `DiscoverySpiMBean`
      Returns:
        Failed nodes count.

    - #### getPendingMessagesRegistered

          @MXBeanDescription(value="Pending messages registered.")
          long getPendingMessagesRegistered()

      Gets pending messages registered count.
      Returns:
        Pending messages registered count.

    - #### getPendingMessagesDiscarded

          @MXBeanDescription(value="Pending messages discarded.")
          long getPendingMessagesDiscarded()

      Gets pending messages discarded count.
      Returns:
        Pending messages registered count.

    - #### getAvgMessageProcessingTime

          @MXBeanDescription(value="Avg message processing time.")
          long getAvgMessageProcessingTime()

      Gets avg message processing time.
      Returns:
        Avg message processing time.

    - #### getMaxMessageProcessingTime

          @MXBeanDescription(value="Max message processing time.")
          long getMaxMessageProcessingTime()

      Gets max message processing time.
      Returns:
        Max message processing time.

    - #### getTotalReceivedMessages

          @MXBeanDescription(value="Total received messages count.")
          int getTotalReceivedMessages()

      Gets total received messages count.
      Returns:
        Total received messages count.

    - #### getReceivedMessages

          @MXBeanDescription(value="Received messages by type.")
          Map<String,Integer> getReceivedMessages()

      Gets received messages counts (grouped by type).
      Returns:
        Map containing message types and respective counts.

    - #### getTotalProcessedMessages

          @MXBeanDescription(value="Total processed messages count.")
          int getTotalProcessedMessages()

      Gets total processed messages count.
      Returns:
        Total processed messages count.

    - #### getProcessedMessages

          @MXBeanDescription(value="Processed messages by type.")
          Map<String,Integer> getProcessedMessages()

      Gets processed messages counts (grouped by type).
      Returns:
        Map containing message types and respective counts.

    - #### getCoordinatorSinceTimestamp

          @MXBeanDescription(value="Local node is coordinator since.")
          long getCoordinatorSinceTimestamp()

      Gets time local node has been coordinator since.
      Returns:
        Time local node is coordinator since.

    - #### getCoordinator

          @MXBeanDescription(value="Coordinator node ID.")
           @Nullable
          @Nullable UUID getCoordinator()

      Gets current coordinator.
      Specified by:
        `getCoordinator` in interface `DiscoverySpiMBean`
      Returns:
        Gets current coordinator.

    - #### getAckTimeout

          @MXBeanDescription(value="Message acknowledgement timeout.")
          long getAckTimeout()

      Gets message acknowledgement timeout.
      Returns:
        Message acknowledgement timeout.

    - #### getMaxAckTimeout

          @MXBeanDescription(value="Maximum message acknowledgement timeout.")
          long getMaxAckTimeout()

      Gets maximum message acknowledgement timeout.
      Returns:
        Maximum message acknowledgement timeout.

    - #### getSocketTimeout

          @MXBeanDescription(value="Socket timeout.")
          long getSocketTimeout()

      Gets socket timeout.
      Returns:
        Socket timeout.

    - #### getJoinTimeout

          @MXBeanDescription(value="The join timeout, in milliseconds. Time to wait for joining. If node cannot connect to any address from the IP finder, the node continues to try to join during this timeout. If all addresses still do not respond, an exception will occur and the node will fail to start. If 0 is specified, it means wait forever.")
          long getJoinTimeout()

      The join timeout, in milliseconds. Time to wait for joining. If node cannot connect to any address from the IP finder, the node continues to try to join during this timeout. If all addresses still do not respond, an exception will occur and the node will fail to start. If 0 is specified, it means wait forever.
      Returns:
        Join timeout.

    - #### dumpDebugInfo

          @MXBeanDescription(value="Dump debug info.")
          void dumpDebugInfo()

      Dumps debug info using configured logger.

    - #### isClientMode

          @MXBeanDescription(value="Client mode.")
          boolean isClientMode()
                                                                 throws IllegalStateException

      Whether or not discovery is started in client mode.
      Returns:
        `true` if node is in client mode.
      Throws:
        `IllegalStateException` - If discovery SPI is not started.

    - #### checkRingLatency

          @MXBeanDescription(value="Check ring latency.")
          void checkRingLatency(@MXBeanParameter(name="maxHops",description="Maximum hops for the message (3 * TOTAL_NODE_CNT is recommended).")
                                                                                int maxHops)

      Diagnosis method for determining ring message latency. On this method call special message will be sent across the ring and stats about the message will appear in the logs of each node.
      Parameters:
        `maxHops` - Maximum hops for the message (3 * TOTAL_NODE_CNT is recommended).

    - #### getCurrentTopologyVersion

          @MXBeanDescription(value="Get current topology version.")
          long getCurrentTopologyVersion()

      Current topology version.
      Returns:
        current topVer.

    - #### dumpRingStructure

          @MXBeanDescription(value="Dumps ring structure to log.")
          void dumpRingStructure()

      Dumps ring structure to log.

${current.year} Copyright © Apache Software Foundation
| Follow @ApacheIgnite
Ignite Database and Caching Platform | : ver. 2.16.0
Release Date | : December 15 2023