Package com.dalsemi.onewire.adapter

Class NetAdapterSim

java.lang.Object
com.dalsemi.onewire.adapter.NetAdapterSim
All Implemented Interfaces:
NetAdapterConstants, Runnable
public class NetAdapterSim extends Object implements Runnable, NetAdapterConstants

NetAdapterSim 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.

NetAdapterSim 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) .

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)

The NetAdapter and NetAdapterSim support multicast broadcasts for automatic discovery of compatible servers on your LAN. To start the multicast listener for this NetAdapterSim, call the createMulticastListener() method .

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

invalid reference 
NetAdapter
.
See Also:
  • invalid reference 
    NetAdapter

  • Field Details

    • SIM_DEBUG

      protected static boolean SIM_DEBUG

    • rand

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

    • logFile

      protected PrintWriter logFile
      Log file

    • execCommand

      protected String execCommand
      exec command, command string to start the simulator

    • process

      protected Process process

    • processOutput

      protected BufferedReader processOutput

    • processError

      protected BufferedReader processError

    • processInput

      protected OutputStreamWriter processInput

    • fakeAddress

      protected byte[] fakeAddress
      fake address, returned from all search or getAddress commands

    • serverSocket

      protected 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 Hashtable<Thread,com.dalsemi.onewire.adapter.NetAdapterSim.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

    • timeOfLastCommand

      protected long timeOfLastCommand

    • IGNORE_TIME_MIN

      protected static final long IGNORE_TIME_MIN
      See Also:

    • IGNORE_TIME_MAX

      protected static final long IGNORE_TIME_MAX
      See Also:

  • Constructor Details

    • NetAdapterSim

      public NetAdapterSim(String execCmd, String logFilename) throws IOException

      Creates an instance of a NetAdapterSim 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 NetAdapterSim will proxy commands to.
      Throws:
      IOException - if a network error occurs or the listen socket cannot be created on the specified port.

    • NetAdapterSim

      public NetAdapterSim(String execCmd, byte[] fakeAddress, String logFile, int listenPort) throws IOException

      Creates a single-threaded instance of a NetAdapterSim 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:
      listenPort - the TCP/IP port to listen on for incoming connections
      adapter - DSPortAdapter that this NetAdapterSim will proxy commands to.
      Throws:
      IOException - if a network error occurs or the listen socket cannot be created on the specified port.

    • NetAdapterSim

      public NetAdapterSim(String execCmd, String logFilename, boolean multiThread) throws IOException

      Creates an (optionally multithreaded) instance of a NetAdapterSim 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:
      multiThread - if true, multiple TCP/IP connections are allowed to interact simultaneously with this adapter.
      adapter - DSPortAdapter that this NetAdapterSim will proxy commands to.
      Throws:
      IOException - if a network error occurs or the listen socket cannot be created on the specified port.

    • NetAdapterSim

      public NetAdapterSim(String execCmd, String logFilename, int listenPort, boolean multiThread) throws IOException

      Creates an (optionally multi-threaded) instance of a NetAdapterSim 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:
      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.
      adapter - DSPortAdapter that this NetAdapterSim will proxy commands to.
      Throws:
      IOException - if a network error occurs or the listen socket cannot be created on the specified port.

    • NetAdapterSim

      public NetAdapterSim(String execCmd, String logFilename, ServerSocket serverSock) throws IOException

      Creates an instance of a NetAdapterSim 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:
      serverSock - the ServerSocket for incoming connections
      adapter - DSPortAdapter that this NetAdapterSim will proxy commands to.
      Throws:
      IOException - if a network error occurs or the listen socket cannot be created on the specified port.

    • NetAdapterSim

      public NetAdapterSim(String execCmd, String logFilename, ServerSocket serverSock, boolean multiThread) throws IOException

      Creates an (optionally multi-threaded) instance of a NetAdapterSim 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:
      serverSock - the ServerSocket for incoming connections
      multiThread - if true, multiple TCP/IP connections are allowed to interact simultaneously with this adapter.
      adapter - DSPortAdapter that this NetAdapterSim will proxy commands to.
      Throws:
      IOException - if a network error occurs or the listen socket cannot be created on the specified port.

  • Method Details

    • setSecret

      public void setSecret(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 IOException, UnknownHostException
      Creates a Multicast Listener to allow NetAdapter clients to discover this NetAdapterSim automatically. Uses defaults for Multicast group and port.
      Throws:
      IOException
      UnknownHostException

    • createMulticastListener

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

    • createMulticastListener

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

    • run

      public void run()
      Run method for threaded NetAdapterSim. 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 Runnable

    • handleConnection

      public void handleConnection(Socket sock) throws 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:
      IOException

    • stopHost

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

    • main

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