001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.q2.iso;
020
021import java.rmi.Remote;
022import java.rmi.RemoteException;
023
024import org.jpos.iso.ISOException;
025import org.jpos.iso.ISOMsg;
026import org.jpos.iso.ISOResponseListener;
027
028/**
029 * RMI based QMUX proxy
030 *
031 * @author Mark Salter
032 * @version $Revision: 2854 $ $Date: 2010-01-02 10:34:31 +0000 (Sat, 02 Jan 2010) $
033 * @since 1.6
034 * @see QMUX
035 */
036
037public interface RemoteQMUX extends Remote  {
038
039    /**
040     * Sends {@code m} and blocks for up to {@code timeout} ms waiting for a matching response.
041     *
042     * @param m message to send
043     * @param timeout time to wait for a message
044     * @return received message or null
045     * @throws ISOException on pack/unpack error
046     * @throws RemoteException if the RMI call fails
047     */
048    ISOMsg request(ISOMsg m, long timeout) throws ISOException, RemoteException;
049
050    /**
051     * Sends {@code m} asynchronously, dispatching the response (or expiration) to {@code r}.
052     *
053     * @param m message to send
054     * @param timeout time to wait for a response
055     * @param r response listener notified on success or expiration
056     * @param handBack opaque token relayed back to {@code r}
057     * @throws ISOException on pack/unpack error
058     * @throws RemoteException if the RMI call fails
059     */
060    void request(ISOMsg m, long timeout, ISOResponseListener r, Object handBack)
061        throws ISOException, RemoteException;
062
063    /**
064     * Indicates whether the underlying MUX is currently connected.
065     *
066     * @return true if connected
067     * @throws RemoteException if the RMI call fails
068     */
069    boolean isConnected() throws RemoteException;
070}
071