```
public class Router
extends Object
```
A trait defining behavior for routing a payment.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Router.RouterInterface

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`finalize()`
`Result_RouteLightningErrorZ`	`find_route(byte[] payer, RouteParameters route_params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs)`	Finds a [`Route`] between `payer` and `payee` for a payment with the given values.
`Result_RouteLightningErrorZ`	`find_route_with_id(byte[] payer, RouteParameters route_params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs, byte[] _payment_hash, byte[] _payment_id)`	Finds a [`Route`] between `payer` and `payee` for a payment with the given values.
`static Router`	`new_impl(Router.RouterInterface arg)`
`void`	`notify_payment_path_failed(RouteHop[] path, long short_channel_id)`	Lets the router know that payment through a specific path has failed.
`void`	`notify_payment_path_successful(RouteHop[] path)`	Lets the router know that payment through a specific path was successful.
`void`	`notify_payment_probe_failed(RouteHop[] path, long short_channel_id)`	Lets the router know that a payment probe failed.
`void`	`notify_payment_probe_successful(RouteHop[] path)`	Lets the router know that a payment probe was successful.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object
Throws:: Throwable

new_impl

public static Router new_impl(Router.RouterInterface arg)

find_route

public Result_RouteLightningErrorZ find_route(byte[] payer,
                                              RouteParameters route_params,
                                              @Nullable
                                              ChannelDetails[] first_hops,
                                              InFlightHtlcs inflight_htlcs)

Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None

find_route_with_id

public Result_RouteLightningErrorZ find_route_with_id(byte[] payer,
                                                      RouteParameters route_params,
                                                      @Nullable
                                                      ChannelDetails[] first_hops,
                                                      InFlightHtlcs inflight_htlcs,
                                                      byte[] _payment_hash,
                                                      byte[] _payment_id)

Finds a [`Route`] between `payer` and `payee` for a payment with the given values. Includes `PaymentHash` and `PaymentId` to be able to correlate the request with a specific payment. Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None

notify_payment_path_failed

public void notify_payment_path_failed(RouteHop[] path,
                                       long short_channel_id)

Lets the router know that payment through a specific path has failed.

notify_payment_path_successful
```
public void notify_payment_path_successful(RouteHop[] path)
```
Lets the router know that payment through a specific path was successful.

notify_payment_probe_successful
```
public void notify_payment_probe_successful(RouteHop[] path)
```
Lets the router know that a payment probe was successful.

notify_payment_probe_failed

public void notify_payment_probe_failed(RouteHop[] path,
                                        long short_channel_id)

Lets the router know that a payment probe failed.

Class Router

Nested Class Summary