Package com.dalsemi.onewire.adapter

Class NetAdapterHost

  • All Implemented Interfaces:
    NetAdapterConstants, java.lang.Runnable
    public class NetAdapterHost
extends java.lang.Object
implements java.lang.Runnable, NetAdapterConstants

    NetAdapterHost is the host (or server) component for a network-based DSPortAdapter. It actually wraps the hardware DSPortAdapter and handles connections from outside sources (NetAdapter) who want to access it.

    NetAdapterHost is designed to be run in a thread, waiting for incoming connections. You can run this in the same thread as your main program or you can establish the connections yourself (presumably using some higher level of security) and then call the handleConnection(Socket) {@see #handleConnection(Socket)}.

    Once a NetAdapter is connected with the host, a version check is performed followed by a simple authentication step. The authentication is dependent upon a secret shared between the NetAdapter and the host. Both will use a default value, that each will agree with if you don't provide a secret of your own. To set the secret, add the following line to your onewire.properties file:

    • NetAdapter.secret="This is my custom secret"
    Optionally, the secret can be set by calling the setSecret(String) {@see #setSecret(String)}

    The NetAdapter and NetAdapterHost support multicast broadcasts for automatic discovery of compatible servers on your LAN. To start the multicast listener for this NetAdapterHost, call the createMulticastListener() method {@see #createMulticastListener()}.

    For information on creating the client component, see the JavaDocs for the NetAdapter.

    See Also:
    NetAdapter

    • Field Detail

      • rand

        protected static final java.util.Random rand
        random number generator, used to issue challenges to client

      • adapter

        protected DSPortAdapter adapter
        The adapter this NetAdapter will proxy too

      • serverSocket

        protected java.net.ServerSocket serverSocket
        The server socket for listening for connections

      • netAdapterSecret

        protected byte[] netAdapterSecret
        secret for authentication with the server

      • hostStopped

        protected volatile boolean hostStopped
        boolean flags for stopping the host

      • hostRunning

        protected volatile boolean hostRunning
        boolean flags for stopping the host

      • singleThreaded

        protected boolean singleThreaded
        boolean flag to indicate whether or not the host is single or multi-threaded

      • hashHandlers

        protected java.util.Hashtable<java.lang.Thread,​com.dalsemi.onewire.adapter.NetAdapterHost.SocketHandler> hashHandlers
        Map of all Service threads created, only for multi-threaded

      • multicastListener

        protected MulticastListener multicastListener
        Optional, listens for datagram packets from potential clients

      • timeoutInSeconds

        protected int timeoutInSeconds
        timeout for socket receive, in seconds

    • Constructor Detail

      • NetAdapterHost

        public NetAdapterHost​(DSPortAdapter adapter)
               throws java.io.IOException

        Creates an instance of a NetAdapterHost which wraps the provided adapter. The host listens on the default port as specified by NetAdapterConstants.

        Note that the secret used for authentication is the value specified in the onewire.properties file as "NetAdapter.secret=mySecret". To set the secret to another value, use the setSecret(String) method.

        Parameters:
        adapter - DSPortAdapter that this NetAdapterHost will proxy commands to.
        Throws:
        java.io.IOException - if a network error occurs or the listen socket cannot be created on the specified port.

      • NetAdapterHost

        public NetAdapterHost​(DSPortAdapter adapter,
                      int listenPort)
               throws java.io.IOException

        Creates a single-threaded instance of a NetAdapterHost which wraps the provided adapter. The host listens on the specified port.

        Note that the secret used for authentication is the value specified in the onewire.properties file as "NetAdapter.secret=mySecret". To set the secret to another value, use the setSecret(String) method.

        Parameters:
        adapter - DSPortAdapter that this NetAdapterHost will proxy commands to.
        listenPort - the TCP/IP port to listen on for incoming connections
        Throws:
        java.io.IOException - if a network error occurs or the listen socket cannot be created on the specified port.

      • NetAdapterHost

        public NetAdapterHost​(DSPortAdapter adapter,
                      boolean multiThread)
               throws java.io.IOException

        Creates an (optionally multithreaded) instance of a NetAdapterHost which wraps the provided adapter. The listen port is set to the default port as defined in NetAdapterConstants.

        Note that the secret used for authentication is the value specified in the onewire.properties file as "NetAdapter.secret=mySecret". To set the secret to another value, use the setSecret(String) method.

        Parameters:
        adapter - DSPortAdapter that this NetAdapterHost will proxy commands to.
        multiThread - if true, multiple TCP/IP connections are allowed to interact simultaneously with this adapter.
        Throws:
        java.io.IOException - if a network error occurs or the listen socket cannot be created on the specified port.

      • NetAdapterHost

        public NetAdapterHost​(DSPortAdapter adapter,
                      int listenPort,
                      boolean multiThread)
               throws java.io.IOException

        Creates an (optionally multi-threaded) instance of a NetAdapterHost which wraps the provided adapter. The host listens on the specified port.

        Note that the secret used for authentication is the value specified in the onewire.properties file as "NetAdapter.secret=mySecret". To set the secret to another value, use the setSecret(String) method.

        Parameters:
        adapter - DSPortAdapter that this NetAdapterHost will proxy commands to.
        listenPort - the TCP/IP port to listen on for incoming connections
        multiThread - if true, multiple TCP/IP connections are allowed to interact simultaneously with this adapter.
        Throws:
        java.io.IOException - if a network error occurs or the listen socket cannot be created on the specified port.

      • NetAdapterHost

        public NetAdapterHost​(DSPortAdapter adapter,
                      java.net.ServerSocket serverSock)
               throws java.io.IOException

        Creates an instance of a NetAdapterHost which wraps the provided adapter. The host listens on the default port as specified by NetAdapterConstants.

        Note that the secret used for authentication is the value specified in the onewire.properties file as "NetAdapter.secret=mySecret". To set the secret to another value, use the setSecret(String) method.

        Parameters:
        adapter - DSPortAdapter that this NetAdapterHost will proxy commands to.
        serverSock - the ServerSocket for incoming connections
        Throws:
        java.io.IOException - if a network error occurs or the listen socket cannot be created on the specified port.

      • NetAdapterHost

        public NetAdapterHost​(DSPortAdapter adapter,
                      java.net.ServerSocket serverSock,
                      boolean multiThread)
               throws java.io.IOException

        Creates an (optionally multi-threaded) instance of a NetAdapterHost which wraps the provided adapter. The host listens on the specified port.

        Note that the secret used for authentication is the value specified in the onewire.properties file as "NetAdapter.secret=mySecret". To set the secret to another value, use the setSecret(String) method.

        Parameters:
        adapter - DSPortAdapter that this NetAdapterHost will proxy commands to.
        serverSock - the ServerSocket for incoming connections
        multiThread - if true, multiple TCP/IP connections are allowed to interact simultaneously with this adapter.
        Throws:
        java.io.IOException - if a network error occurs or the listen socket cannot be created on the specified port.

    • Method Detail

      • setSecret

        public void setSecret​(java.lang.String secret)
        Sets the secret used for authenticating incoming client connections.
        Parameters:
        secret - The shared secret information used for authenticating incoming client connections.

      • createMulticastListener

        public void createMulticastListener()
                             throws java.io.IOException,
                                    java.net.UnknownHostException
        Creates a Multicast Listener to allow NetAdapter clients to discover this NetAdapterHost automatically. Uses defaults for Multicast group and port.
        Throws:
        java.io.IOException
        java.net.UnknownHostException

      • createMulticastListener

        public void createMulticastListener​(int port)
                             throws java.io.IOException,
                                    java.net.UnknownHostException
        Creates a Multicast Listener to allow NetAdapter clients to discover this NetAdapterHost automatically. Uses default for Multicast group.
        Parameters:
        port - The port the Multicast socket will receive packets on
        Throws:
        java.io.IOException
        java.net.UnknownHostException

      • createMulticastListener

        public void createMulticastListener​(int port,
                                    java.lang.String group)
                             throws java.io.IOException,
                                    java.net.UnknownHostException
        Creates a Multicast Listener to allow NetAdapter clients to discover this NetAdapterHost automatically.
        Parameters:
        port - The port the Multicast socket will receive packets on
        group - The group the Multicast socket will join
        Throws:
        java.io.IOException
        java.net.UnknownHostException

      • run

        public void run()
        Run method for threaded NetAdapterHost. Maintains server socket which waits for incoming connections. Whenever a connection is received launches it services the socket or (optionally) launches a new thread for servicing the socket.
        Specified by:
        run in interface java.lang.Runnable

      • handleConnection

        public void handleConnection​(java.net.Socket sock)
                      throws java.io.IOException
        Handles a socket connection. If single-threaded, the connection is serviced in the current thread. If multi-threaded, a new thread is created for servicing this connection.
        Throws:
        java.io.IOException

      • stopHost

        public void stopHost()
        Stops all threads and kills the server socket.

      • main

        public static void main​(java.lang.String[] args)
                 throws java.lang.Exception
        A Default Main Method, for launching NetAdapterHost getting the default adapter with the OneWireAccessProvider and listening on the default port specified by DEFAULT_PORT.
        Throws:
        java.lang.Exception