org.interledger.link.LinkSender Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of link-core Show documentation

A Link abstraction for connecting Interledger peers.

There is a newer version: 1.3.1

package org.interledger.link;

import org.interledger.core.InterledgerFulfillPacket;
import org.interledger.core.InterledgerPreparePacket;
import org.interledger.core.InterledgerRejectPacket;
import org.interledger.core.InterledgerResponsePacket;

import java.util.function.Consumer;
import java.util.function.Function;

/**
 * Defines how to send data to the other side of a bilateral link (i.e., the other party operating a single account in
 * tandem with the operator of this sender).
 */
@FunctionalInterface
public interface LinkSender {

  /**
   * Sends an ILPv4 request packet to a peer and returns the response packet (if one is returned).
   *
   * This method supports one of three responses, which can be handled by using either
   * {@link InterledgerResponsePacket#handle(Consumer, Consumer)} or {@link InterledgerResponsePacket#map(Function,
   * Function)}.
   * 
   *
   * 
   *   An instance of {@link InterledgerFulfillPacket}, which means the packet was fulfilled by the receiver.
   *   An instance of {@link InterledgerRejectPacket}, which means the packet was rejected by one of the nodes in
   *   the payment path.
   *   
   * 
   *
   * @param preparePacket An {@link InterledgerPreparePacket} to send to the remote peer.
   *
   * @return An {@link InterledgerResponsePacket}, which will be of concrete type {@link InterledgerFulfillPacket} or }
   *     } or {@link InterledgerRejectPacket}.
   */
  InterledgerResponsePacket sendPacket(InterledgerPreparePacket preparePacket);

}