com.ascert.open.term.core.TnAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openterm Show documentation
An open source emulator supporting 3270 and potentially later 5250 terminal types.
The newest version!
/*
 * Copyright (c) 2016, 2017 Ascert, LLC.
 * www.ascert.com
 *
 * Based on original code from FreeHost3270, copyright for derivations from original works remain:
 *  Copyright (C) 1998, 2001  Art Gillespie
 *  Copyright (2) 2005 the http://FreeHost3270.Sourceforge.net
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package com.ascert.open.term.core;

/**
 * Provides a callback to consumers from the RWTelnet object. When developing a 3270 client using the RightHost APIs, you must implement
 * this interface and pass it to the RW3270 Object when it's instantiated. It provides several important methods that the 3270 engine calls
 * to inform the implementation of 3270 events.
 *
 * @see net.sf.freehost3270.client.RW3270
 */
public interface TnAction
{

    /**
     * Status constant passed to status() indicating that there was a problem connecting to the 3270 host
     */
    public static final int CONNECTION_ERROR = -2;

    /**
     * Status constant passed to status() indicating that the client's connection to the host has been closed.
     */
    public static final int DISCONNECTED_BY_REMOTE_HOST = -1;

    public static final int DISCONNECTED = 0;

    public static final int CONNECTING = 1;

    /**
     * Status constant passed to status() indicating that the 3270 engine is waiting for a response from the 3270 host.
     */
    public static final int X_WAIT = 2;

    /**
     * Status constant passed to status() indicating that the 3270 engine is ready for user input
     */
    public static final int READY = 3;

    /**
     * This method is called when the host application sends the beep command. It should fire some sort of audible alarm on the client's
     * system. For example:
     *      * public void beep() {
     *    Toolkit.getDefaultToolkit().beep();
     * }
     * 
     */
    default void beep()
    {
    }

    /**
     * This method is called when the SessionServer admin sends a broadcast message to all currently connected clients.
     *
     * 
     * If you're implementing Broadcast Messaging in your client, this method should paint String msg to the client's screen.
     * 
     *
     * @param msg The broadcast message from the system administrator.
     */
    default void broadcastMessage(String msg)
    {
    }

    /**
     * Is called by the 3270 telnet engine when it has received new data.
     *
     * 
     * This method would usually call a paint() method or other display update. Note: this method is useful when the client implementation
     * is stateful. If the 3270 engine does not have direct access to the user's display, the RW3270.waitForNewData() method will suspend
     * the calling thread until new data arrives.
     * 
     */
    default void refresh()
    {
    }

    /**
     * This method is called by the 3270 engine to communicate status changes to the client. The possible values for int are outlined in the
     * constants for this field.
     *
     * 
     * 
     * RWtnAction.DISCONNECTED_BY_REMOTE_HOST: This status message indicates that the connection to the host was lost.
     * 
     * 
     * TnAction.CONNECTION_ERROR: This status message that there was a problem connecting to the SessionServer or that the SessionServer had
     * trouble connecting to the 3270 host.
     * 
     * 
     * TnAction.X_WAIT: This status message means the 3270 engine is waiting for a response from the 3270 host.
     * 
     * 
     * TnAction.READY: This status message means the 3270 engine is ready for input from the client implementation.
     * 
     * 
     *
     *
     * @param msg The status message
     */
    default void status(int msg)
    {
    }

    default boolean clearStatus()
    {
        return false;
    }

    // Possibly doesn't belong here, but will do for now
    default void printScreen()
    {
    }

}