PaymentProgress

While the payment is in progress, we listen to child payment failures. When we receive such failures, we request our up-to-date local channels balances and retry the failed child payments with a potentially different route.

sender: the sender of the payment request.
request: payment request containing the total amount to send.
networkStats: network statistics help us decide how to best split a big payment.
channelsCount: number of local channels.
toSend: remaining amount that should be split and sent.
remainingAttempts: remaining attempts (after child payments fail).
pending: pending child payments (payment sent, we are waiting for a fulfill or a failure).
ignoreChannels: channels that should be ignored (previously returned a permanent error).
failures: previous child payment failures.

Linear Supertypes

Serializable, Serializable, Product, Equals, Data, AnyRef, Any

Instance Constructors

new PaymentProgress(sender: ActorRef, request: SendMultiPartPayment, networkStats: Option[NetworkStats], channelsCount: Int, toSend: MilliSatoshi, remainingAttempts: Int, pending: Map[UUID, SendPayment], ignoreChannels: Set[ShortChannelId], failures: Seq[PaymentFailure])

sender
the sender of the payment request.
request
payment request containing the total amount to send.
networkStats
network statistics help us decide how to best split a big payment.
channelsCount
number of local channels.
toSend
remaining amount that should be split and sent.
remainingAttempts
remaining attempts (after child payments fail).
pending
pending child payments (payment sent, we are waiting for a fulfill or a failure).
ignoreChannels
channels that should be ignored (previously returned a permanent error).
failures
previous child payment failures.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val channelsCount: Int

number of local channels.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val failures: Seq[PaymentFailure]

previous child payment failures.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
val ignoreChannels: Set[ShortChannelId]

channels that should be ignored (previously returned a permanent error).
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val networkStats: Option[NetworkStats]

network statistics help us decide how to best split a big payment.
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
val pending: Map[UUID, SendPayment]

pending child payments (payment sent, we are waiting for a fulfill or a failure).
val remainingAttempts: Int

remaining attempts (after child payments fail).
val request: SendMultiPartPayment

payment request containing the total amount to send.
val sender: ActorRef

the sender of the payment request.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val toSend: MilliSatoshi

remaining amount that should be split and sent.
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package MultiPartPaymentLifecycle

Instance Constructors

new PaymentProgress(sender: ActorRef, request: SendMultiPartPayment, networkStats: Option[NetworkStats], channelsCount: Int, toSend: MilliSatoshi, remainingAttempts: Int, pending: Map[UUID, SendPayment], ignoreChannels: Set[ShortChannelId], failures: Seq[PaymentFailure])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val channelsCount: Int

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

val failures: Seq[PaymentFailure]

final def getClass(): Class[_]

val ignoreChannels: Set[ShortChannelId]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

val networkStats: Option[NetworkStats]

final def notify(): Unit

final def notifyAll(): Unit

val pending: Map[UUID, SendPayment]

val remainingAttempts: Int

val request: SendMultiPartPayment

val sender: ActorRef

final def synchronized[T0](arg0: ⇒ T0): T0

val toSend: MilliSatoshi

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Data

Inherited from AnyRef

Inherited from Any

Ungrouped