com.ericsson.otp.erlang.OtpNodeStatus Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jinterface Show documentation

Jinterface Java package contains java classes, which help you integrate programs written in Java with Erlang. Erlang is a programming language designed at the Ericsson Computer Science Laboratory.

There is a newer version: 1.6.1

Show newest version

/*
 * %CopyrightBegin%
 * 
 * Copyright Ericsson AB 2000-2009. All Rights Reserved.
 * 
 * The contents of this file are subject to the Erlang Public License,
 * Version 1.1, (the "License"); you may not use this file except in
 * compliance with the License. You should have received a copy of the
 * Erlang Public License along with this software. If not, it can be
 * retrieved online at http://www.erlang.org/.
 * 
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 * 
 * %CopyrightEnd%
 */
package com.ericsson.otp.erlang;

/**
 * 
 * Provides a callback mechanism for receiving status change information about
 * other nodes in the system. Register an instance of this class (or a subclass)
 * with your {@link OtpNode OtpNode} when you wish to be notified about such
 * status changes and other similar events.
 * 
 * 
 * 
 * This class provides default handers that ignore all events. Applications are
 * expected to extend this class in order to act on events that are deemed
 * interesting.
 * 
 * 
 * 
 *  Note that this class is likely to change in the near future 
 * 
 */
public class OtpNodeStatus {
    public OtpNodeStatus() {
    }

    /**
     * Notify about remote node status changes.
     * 
     * @param node
     *                the node whose status change is being indicated by this
     *                call.
     * 
     * @param up
     *                true if the node has come up, false if it has gone down.
     * 
     * @param info
     *                additional info that may be available, for example an
     *                exception that was raised causing the event in question
     *                (may be null).
     * 
     */
    public void remoteStatus(final String node, final boolean up,
	    final Object info) {
    }

    /**
     * Notify about local node exceptions.
     * 
     * @param node
     *                the node whose status change is being indicated by this
     *                call.
     * 
     * @param up
     *                true if the node has come up, false if it has gone down.
     * 
     * @param info
     *                additional info that may be available, for example an
     *                exception that was raised causing the event in question
     *                (may be null).
     */
    public void localStatus(final String node, final boolean up,
	    final Object info) {
    }

    /**
     * Notify about failed connection attempts.
     * 
     * @param node
     *                The name of the remote node
     * 
     * @param incoming
     *                The direction of the connection attempt, i.e. true for
     *                incoming, false for outgoing.
     * 
     * @param info
     *                additional info that may be available, for example an
     *                exception that was raised causing the event in question
     *                (may be null).
     */
    public void connAttempt(final String node, final boolean incoming,
	    final Object info) {
    }
}