SessionRunContext

Provides information about the original request to Session.run() function. Hooks can stop the loop by calling the requestStop() method of SessionRunContext. In the future we may use this object to add more information about the request to run without changing the Hook API.

args: Arguments to the original request to Session.run().
session: Session that will execute the run request.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new SessionRunContext(args: SessionRunArgs[F, E, R], session: SessionWrapper)(implicit executableEv: Executable[E], fetchableEv: Aux[F, R])

args
Arguments to the original request to Session.run().
session
Session that will execute the run request.

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
val args: SessionRunArgs[F, E, R]

Arguments to the original request to Session.run().
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def requestStop(): Unit

Sets the stop requested field to true.
Sets the stop requested field to true. Hooks can use this function to request stop of iterations. MonitoredSession checks whether that field has been set or not.
val session: SessionWrapper

Session that will execute the run request.
def stopRequested: Boolean

Returns a boolean value representing whether a stop has been requested or not.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package Hook

case class SessionRunContext[F, E, R](args: SessionRunArgs[F, E, R], session: SessionWrapper)(implicit executableEv: Executable[E], fetchableEv: Aux[F, R]) extends Product with Serializable

Instance Constructors

new SessionRunContext(args: SessionRunArgs[F, E, R], session: SessionWrapper)(implicit executableEv: Executable[E], fetchableEv: Aux[F, R])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val args: SessionRunArgs[F, E, R]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def requestStop(): Unit

val session: SessionWrapper

def stopRequested: Boolean

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped