Package com.kristensoft.kdc

Class Server

  • All Implemented Interfaces:
    Closeable, AutoCloseable, Runnable
    Direct Known Subclasses:
    KristenHttpServer, TcpServer, WebSocketServer
    public abstract class Server
extends Object
implements Closeable, Runnable
    Provides the base implementation for KDC communication servers.

    A server runs on its own thread and manages clients created from incoming connections. Connected clients may be maintained in the server's Hub, allowing agents to be broadcast to all clients associated with the server.

    Transport-specific servers extend this class to provide the server's main processing and shutdown behavior.

    Author:
    Charles B. Kozoyed
    See Also:
    CommsEntity, ServerParameters, Hub

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void close()
      Closes this server and releases its transport-specific resources.
      void flushMetrics()
      Flushes the accumulated latency metrics for this communication entity.
      AgentSerializer getAgentSerializer()
      Returns the agent serializer used by this communication entity.
      int getBacklog()
      Returns the maximum number of pending connections allowed in the server's connection backlog.
      Hub getHub()
      Returns the hub containing the clients associated with this server.
      void halt()
      Stops this server and closes its transport-specific resources.
      boolean isRunning()
      Determines whether this communication entity is currently running.
      abstract void run()
      Executes the main processing loop for this server.
      void sendAsync​(Agent agent)
      Sends an asynchronous agent to all clients connected to this server.
      void start()
      Starts the server thread responsible for accepting incoming connections.
      void stop()
      Stops the server thread responsible for accepting incoming connections.

    • Method Detail

      • run

        public abstract void run()
        Executes the main processing loop for this server.

        Transport-specific server implementations provide the logic required to accept and process incoming connections or requests.

        Specified by:
        run in interface Runnable

      • close

        public abstract void close()
        Closes this server and releases its transport-specific resources.
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable

      • sendAsync

        public void sendAsync​(Agent agent)
               throws IOException
        Sends an asynchronous agent to all clients connected to this server.
        Parameters:
        agent - the agent to send
        Throws:
        IOException - if an I/O error occurs while sending the agent

      • halt

        public void halt()
        Stops this server and closes its transport-specific resources.

        This method stops the server thread responsible for accepting incoming connections and then closes the server.

      • start

        public void start()
        Starts the server thread responsible for accepting incoming connections.

        If the server is already running, this method has no effect.

      • stop

        public void stop()
        Stops the server thread responsible for accepting incoming connections.

        The server is marked as no longer running and, if a server thread exists, the thread is interrupted and this method waits for it to terminate.

      • getBacklog

        public final int getBacklog()
        Returns the maximum number of pending connections allowed in the server's connection backlog.
        Returns:
        the server connection backlog

      • getHub

        public final Hub getHub()
        Returns the hub containing the clients associated with this server.

        The hub may be used to access the server's clients and to broadcast agents to all connected clients.

        Returns:
        the server's hub

      • isRunning

        public boolean isRunning()
        Determines whether this communication entity is currently running.
        Returns:
        true if this communication entity is running; false otherwise

      • flushMetrics

        public void flushMetrics()
        Flushes the accumulated latency metrics for this communication entity.

        This method may be used to report any currently accumulated metrics without waiting for the configured latency reporting interval.

      • getAgentSerializer

        public AgentSerializer getAgentSerializer()
        Returns the agent serializer used by this communication entity.

        The serializer may be used to inspect or modify serialization settings at runtime, including compression and encryption settings.

        Returns:
        the agent serializer used by this communication entity