net.wimpi.modbus.net.TCPSlaveConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jamod Show documentation
jamod is an object oriented implementation of the Modbus protocol, realized 100% in Java. It allows to quickly realize master and slave applications in various transport flavors (IP and serial).
The newest version!
/***
 * Copyright 2002-2010 jamod development team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ***/

package net.wimpi.modbus.net;

import java.io.IOException;
import java.net.InetAddress;
import java.net.Socket;

import net.wimpi.modbus.Modbus;
import net.wimpi.modbus.io.ModbusTCPTransport;
import net.wimpi.modbus.io.ModbusTransport;

/**
 * Class that implements a TCPSlaveConnection.
 *
 * @author Dieter Wimberger
 * @version 1.2 (@date@)
 */
public class TCPSlaveConnection {

  //instance attributes
  private Socket m_Socket;
  private int m_Timeout = Modbus.DEFAULT_TIMEOUT;
  private boolean m_Connected;
  private ModbusTCPTransport m_ModbusTransport;

  /**
   * Constructs a TCPSlaveConnection instance
   * using a given socket instance.
   *
   * @param socket the socket instance to be used for communication.
   */
  public TCPSlaveConnection(Socket socket) {
    try {
      setSocket(socket);
    } catch (IOException ex) {
       if(Modbus.debug) System.out.println("TCPSlaveConnection::Socket invalid.");
      //@commentstart@
      throw new IllegalStateException("Socket invalid.");
      //@commentend@
    }
  }//constructor

  /**
   * Closes this TCPSlaveConnection.
   */
  public void close() {
    if(m_Connected) {
      try {
        m_ModbusTransport.close();
        m_Socket.close();
      } catch (IOException ex) {
        if(Modbus.debug) ex.printStackTrace();
      }
      m_Connected = false;
    }
  }//close

  /**
   * Returns the ModbusTransport associated with this
   * TCPMasterConnection.
   *
   * @return the connection's ModbusTransport.
   */
  public ModbusTransport getModbusTransport() {
    return m_ModbusTransport;
  }//getIO

  /**
   * Prepares the associated ModbusTransport of this
   * TCPMasterConnection for use.
   *
   * @param socket the socket to be used for communication.
   * @throws IOException if an I/O related error occurs.
   */
  private void setSocket(Socket socket) throws IOException {
    m_Socket = socket;
    if (m_ModbusTransport == null) {
      m_ModbusTransport = new ModbusTCPTransport(m_Socket);
    } else {
      m_ModbusTransport.setSocket(m_Socket);
    }
    m_Connected = true;
  }//prepareIO

  /**
   * Returns the timeout for this TCPMasterConnection.
   *
   * @return the timeout as int.
   */
  public int getTimeout() {
    return m_Timeout;
  }//getReceiveTimeout

  /**
   * Sets the timeout for this TCPSlaveConnection.
   *
   * @param timeout the timeout as int.
   */
  public void setTimeout(int timeout) {
    m_Timeout = timeout;
    try {
      m_Socket.setSoTimeout(m_Timeout);
    } catch (IOException ex) {
      //handle?
    }
  }//setReceiveTimeout

  /**
   * Returns the destination port of this
   * TCPMasterConnection.
   *
   * @return the port number as int.
   */
  public int getPort() {
    return m_Socket.getLocalPort();
  }//getPort

  /**
   * Returns the destination InetAddress of this
   * TCPMasterConnection.
   *
   * @return the destination address as InetAddress.
   */
  public InetAddress getAddress() {
    return m_Socket.getLocalAddress();
  }//getAddress

  /**
   * Tests if this TCPMasterConnection is connected.
   *
   * @return true if connected, false otherwise.
   */
  public boolean isConnected() {
    return m_Connected;
  }//isConnected

}//class TCPSlaveConnection