Logo FsShelter

Spout Module

Functions and values

Function or value Description

ofExternal comp

Full Usage: ofExternal comp

Parameters:
Returns: Spout<'t>
Type parameters: 't

define a spout for a (external) shell or java component

comp : Component<'t>
Returns: Spout<'t>

runReliable mkArgs mkAcker deactivate next

Full Usage: runReliable mkArgs mkAcker deactivate next

Parameters:
    mkArgs : (LogLevel -> string -> unit) -> Conf -> 'args
    mkAcker : 'args -> Acker
    deactivate : 'args -> unit
    next : Next<'args, (TupleId * 't)>

Returns: Spout<'t>
Type parameters: 'args, 't

define a reliable spout mkArgs: one-time construction of arguments that will be passed into each next() call. mkAcker: one time construction of `Ack*Nack` handlers (using the args). next: spout function that returns an id*tuple option.

mkArgs : (LogLevel -> string -> unit) -> Conf -> 'args
mkAcker : 'args -> Acker
deactivate : 'args -> unit
next : Next<'args, (TupleId * 't)>
Returns: Spout<'t>

runUnreliable mkArgs deactivate next

Full Usage: runUnreliable mkArgs deactivate next

Parameters:
    mkArgs : (LogLevel -> string -> unit) -> Conf -> 'args
    deactivate : 'args -> unit
    next : Next<'args, 't>

Returns: Spout<'t>
Type parameters: 'args, 't

define spout with no processing guarantees mkArgs: one-time construction of arguments that will be passed into each next() call. next: spout function that returns a tuple option.

mkArgs : (LogLevel -> string -> unit) -> Conf -> 'args
deactivate : 'args -> unit
next : Next<'args, 't>
Returns: Spout<'t>

Type something to start searching.