org.jgroups.protocols.LocalTransport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 34.0.0.Final

Show newest version

package org.jgroups.protocols;

import org.jgroups.Address;
import org.jgroups.View;

/**
 * A local transport is used for sending messages only to single (or all) members of the same host.
 * @author Bela Ban
 * @since  5.2.0
 */
public interface LocalTransport {
    /**
     * Calls after the local transport has been created.
     * @param transport A reference to TP
     */
    LocalTransport init(TP transport) throws Exception;
    LocalTransport start() throws Exception;
    LocalTransport stop();
    LocalTransport destroy();
    LocalTransport resetStats();

    LocalTransport viewChange(View v);

    /** Returns true if addr is a local member, false otherwise */
    boolean isLocalMember(Address addr);

    /**
     * Sends a message to a given local member. The caller should check before whether dest is a local member;
     * an implementation is not required to do so, but may nevertheless perform the check (and throw an
     * exception if the destination is not local).
     * @param dest The address of the member to which to send the message. Must be non-null
     * @param buf The buffer to send
     * @param offset The offset at which the data starts
     * @param length The number of bytes to send
     * @exception Exception Thrown when the send failed, e.g. when dest isn't a local address.
     */
    void sendTo(Address dest, byte[] buf, int offset, int length) throws Exception;

    /**
     * Sends a message to all local members.
     * @param buf The buffer to send
     * @param offset The offset at which the data starts
     * @param length The number of bytes to send
     * @exception Exception Thrown when the send failed.
     */
    void sendToAll(byte[] buf, int offset, int length) throws Exception;
}