Logo FsShelter

DSL Module

Embedded DSL for defining the topologies

Types and nested modules

Type/Module Description

Bolt

Spout

Ack

ack signature

Acker

ack/nack tuple

All

define all grouping

Consume<'a>

bolt function signature

Direct

define direct grouping

Emit<'t>

emit signature

Group

define fields grouping

Nack

nack signature

Next<'a, 't>

spout function signature

Shuffle

define shuffle grouping

TopologyBuilder

TopologyBuilder computation expression

Functions and values

Function or value Description

t ++ t2

Full Usage: t ++ t2

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

combine two topologies under the first topology's name

t : Topology<'t>
t2 : Topology<'t>
Returns: Topology<'t>

arg0 --> arg1

Full Usage: arg0 --> arg1

Parameters:
    arg0 : 'a
    arg1 : Bolt<'t>

Returns: bool
Modifiers: inline
Type parameters: 'a, 't

stream, subsequent emits are NOT anchored

arg0 : 'a
arg1 : Bolt<'t>
Returns: bool

arg0 ==> arg1

Full Usage: arg0 ==> arg1

Parameters:
    arg0 : 'a
    arg1 : Bolt<'t>

Returns: bool
Modifiers: inline
Type parameters: 'a, 't

stream and anchor subsequent emits

arg0 : 'a
arg1 : Bolt<'t>
Returns: bool

java className args

Full Usage: java className args

Parameters:
    className : string
    args : string list

Returns: Component<'a>
Type parameters: 'a

wrap (Storm native) java component definition

className : string
args : string list
Returns: Component<'a>

shell command args

Full Usage: shell command args

Parameters:
    command : string
    args : string

Returns: Component<'a>
Type parameters: 'a

wrap (external) shell component definition

command : string
args : string
Returns: Component<'a>

topology name

Full Usage: topology name

Parameters:
    name : string

Returns: TopologyBuilder

topology builder instance

name : string
Returns: TopologyBuilder

withActivation tuple spec

Full Usage: withActivation tuple spec

Parameters:
    tuple : 't
    spec : ^s

Returns: ^s
Modifiers: inline
Type parameters: 't, ^s (requires (static member WithActivation : ^s * 't -> ^s))

supply component Activation tuple

tuple : 't
spec : ^s
Returns: ^s

withConf conf spec

Full Usage: withConf conf spec

Parameters:
Returns: ^s
Modifiers: inline
Type parameters: ^s (requires (static member WithConf : ^s * FsShelter.Conf -> ^s))

supply component configuration/overrides

conf : ConfOption list
spec : ^s
Returns: ^s

withDeactivation tuple spec

Full Usage: withDeactivation tuple spec

Parameters:
    tuple : 't
    spec : ^s

Returns: ^s
Modifiers: inline
Type parameters: 't, ^s (requires (static member WithDeactivation : ^s * 't -> ^s))

supply component Deactivation tuple

tuple : 't
spec : ^s
Returns: ^s

withExecutors executors spec

Full Usage: withExecutors executors spec

Parameters:
    executors : ^a
    spec : ^s

Returns: ^s
Modifiers: inline
Type parameters: ^a, ^s (requires (static member op_Explicit : ^a -> Microsoft.FSharp.Core.uint32) and (static member WithExecutors : ^s * Microsoft.FSharp.Core.uint32 -> ^s))

override default number of executors (threads) for tasks

executors : ^a
spec : ^s
Returns: ^s

withParallelism parallelism spec

Full Usage: withParallelism parallelism spec

Parameters:
    parallelism : ^a
    spec : ^s

Returns: ^s
Modifiers: inline
Type parameters: ^a, ^s (requires (static member op_Explicit : ^a -> Microsoft.FSharp.Core.uint32) and (static member WithParallelism : ^s * Microsoft.FSharp.Core.uint32 -> ^s))

override default parallelism

parallelism : ^a
spec : ^s
Returns: ^s

Type something to start searching.