ro.ciprianpascu.sbus.io.ModbusTransaction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of j2sbus Show documentation
jamod is an object oriented implementation of the S-Bus 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 ro.ciprianpascu.sbus.io;

import ro.ciprianpascu.sbus.ModbusException;
import ro.ciprianpascu.sbus.msg.ModbusRequest;
import ro.ciprianpascu.sbus.msg.ModbusResponse;

/**
 * Interface defining a ModbusTransaction.
* 
 * A transaction is defined by the sequence of
 * sending a request message and receiving a
 * related response message.
 *
 * @author Dieter Wimberger
 * @author Ciprian Pascu

 * @version %I% (%G%)
 */
public interface ModbusTransaction {

    /**
     * Sets the {@link ModbusRequest} for this
     * {@link ModbusTransaction}.
* 
     * The related {@link ModbusResponse} is acquired
     * from the passed in {@link ModbusRequest} instance.

* 
     *
     * @param req a {@link ModbusRequest}.
     */
    public void setRequest(ModbusRequest req);

    /**
     * Returns the {@link ModbusRequest} instance
     * associated with this {@link ModbusTransaction}.
* 
     *
     * @return the associated {@link ModbusRequest} instance.
     */
    public ModbusRequest getRequest();

    /**
     * Returns the {@link ModbusResponse} instance
     * associated with this {@link ModbusTransaction}.
* 
     *
     * @return the associated {@link ModbusRequest} instance.
     */
    public ModbusResponse getResponse();

    /**
     * Returns the actual transaction identifier of
     * this {@link ModbusTransaction}.
     * The identifier is a 2-byte (short) non negative
     * String value subnetId + _ + unitId + _ + functionCode

     * 
     *
     * @return the actual transaction identifier as
     *         {@link int}.
     */
    public String getTransactionID();

    /**
     * Set the amount of retries for opening
     * the connection for executing the transaction.	
     * 
     *
     * @param retries the amount of retries as {@link int}.
     */
    public void setRetries(int retries);

    /**
     * Returns the amount of retries for opening
     * the connection for executing the transaction.
     * 
     *
     * @return the amount of retries as {@link int}.
     */
    public int getRetries();

    /**
     * Sets the time to wait in milliseconds between retries
     * 
     * @param retryDelayMillis the time to wait in milliseconds between retries
     */
    public void setRetryDelayMillis(long retryDelayMillis);

    /**
     * Returns the time to wait in milliseconds between retries
     *
     * @return time to wait in milliseconds between retries as {@link long}
     */
    public long getRetryDelayMillis();

    /**
     * Sets the flag that controls whether the
     * validity of a transaction will be checked.
     * 
     *
     * @param b true if checking validity, false otherwise.
     */
    public void setCheckingValidity(boolean b);

    /**
     * Tests whether the validity of a transaction
     * will be checked.
     * 
     *
     * @return true if checking validity, false otherwise.
     */
    public boolean isCheckingValidity();

    /**
     * Executes this {@link ModbusTransaction}.
     * Locks the {@link ModbusTransport} for sending
     * the {@link ModbusRequest} and reading the
     * related {@link ModbusResponse}.
     * If reconnecting is activated the connection will
     * be opened for the transaction and closed afterwards.
     * 
     *
     * @throws ModbusException if an I/O error occurs,
     *             or the response is a modbus protocol exception.
     */
    public void execute() throws ModbusException;

}// interface ModbusTransaction