org.jgroups.tests.rt.RtTransport 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.tests.rt;

import java.util.List;

/**
 * Transport for the {@link org.jgroups.tests.RoundTrip} test
 * @author Bela Ban
 * @since  4.0
 */
public interface RtTransport {

    /**
     * Prints the accepted options, e.g. [-host host] [-port port] [-server host]
     * @return
     */
    String[] options();

    /**
     * Sets options on this transport. Usually done after creation and before {@link #start(String...)} is called,
     * but may also be called at runtime.
     * @param options The options
     * @throws Exception
     */
    void options(String ... options) throws Exception;

    /**
     * Sets the receiver whose {@link RtReceiver#receive(Object,byte[],int,int)} callback will be invoked whenever a
     * message is received
     * @param receiver
     */
    void receiver(RtReceiver receiver);

    /**
     * Returns the local addres of this member.
     * @return The local address. Implementations without cluster membership may return null
     */
    Object localAddress();

    /**
     * Returns the addresses of all cluster members. May return null if not implemented
     * @return The list of all members in the cluster
     */
    List clusterMembers();

    /**
     * Starts the transport, e.g. connecting to a server socket
     * @param options Options passed to the transport at startup time. May be null
     * @throws Exception
     */
    void start(String... options) throws Exception;

    /**
     * Stops the transport, e.g. stopping the accept() loop in a TCP-based server
     */
    void stop();

    /**
     * Sends a message
     * @param dest The destination address
     * @param buf The buffer
     * @param offset The offset at which the data starts
     * @param length The length (in bytes) of the data to send
     * @throws Exception
     */
    void send(Object dest, byte[] buf, int offset, int length) throws Exception;
}