org.thales.punch.libraries.punchlang.api

Class PunchletDag

java.lang.Object

org.thales.punch.libraries.punchlang.impl.PunchletContext

org.thales.punch.libraries.punchlang.api.Punchlet

org.thales.punch.libraries.punchlang.api.Punchlets

org.thales.punch.libraries.punchlang.api.PunchletDag

All Implemented Interfaces:

Runnable

public class PunchletDag
extends Punchlets
implements Runnable

A punchlet dag is a lightweight topology like engine that runs a directed graph of several layers of punchlets, each in its own thread.

This is used for high performance lightweight topologies, avoiding the storm?flink node to node serialisation.

Field Summary

Fields inherited from class org.thales.punch.libraries.punchlang.api.Punchlets

punchletList

Fields inherited from class org.thales.punch.libraries.punchlang.api.Punchlet

_threadLocal, LOG

Fields inherited from class org.thales.punch.libraries.punchlang.impl.PunchletContext

child, code, eventCount, metricRegistry, r, uuidGenerator, world

Constructor Summary

Constructors

Constructor and Description
PunchletDag() Default ctor

Method Summary

Modifier and Type	Method and Description
boolean	__isChained() some punchlet are made of a chain of several punchlets.
void	activate() The activate method is called after startup, and before receiving input tuples.
void	add(List<Punchlet> punchlets, String affinity) Add a punchlet to the list
void	addBlock(List<PunchletSequence> punchlets, String affinity)
void	execute(Tuple root) Execute the punchlet.
void	execute(Tuple root, org.thales.punch.api.IReceiver<Tuple> receiver) Execute a chain of punchlet starting from a specific one.
static int	getQueueNum(LinkedBlockingQueue<Tuple> q)
void	run()

Methods inherited from class org.thales.punch.libraries.punchlang.api.Punchlets

addEventCallback, isAsynchronous, setMetricContext

Methods inherited from class org.thales.punch.libraries.punchlang.api.Punchlet

attach, bug, cef, cidrRange, cidrRange, coalesce, contains, contains, convert, convert, csv, currentTimeMillis, currentTimeNanos, date, date, date, dissect, dump, fetchCsv, fetchCsv, fetchJson, fetchJson, findByInterval, findByInterval, findByInterval, findByKey, findByKey, geo, geoip, geoOperator, getAttachement, getCode, getHostIp, getHostName, getResource, getResourceString, getResourceTuple, getUniqueMessageId, grok, http, ipmatch, ipmatch, ipRange, ipv4Range, ipv4Range, ipv6Range, ipv6Range, is, kv, logger, mail, meter, move, nifi, print, print, raise, remove, sha1, sleep, split, syslogHeader, toArray, toBoolean, toDouble, toFlatTuple, toKv, toLong, toLowerCase, toUpperCase, tryEpochMs, tryEpochMs, tryEpochSec, tryEpochSec, tuple, tuple, unflatTuple, validateSchema

Methods inherited from class org.thales.punch.libraries.punchlang.impl.PunchletContext

ecount, every, getPath, getPersistentId, getProperties, getRuntimeId, getWorldTuple, invoke, setCode, setPath, setPersistentId, setProperties, setRuntimeId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PunchletDag

public PunchletDag()

Default ctor

Method Detail

activate

public void activate()

Description copied from class: Punchlet

The activate method is called after startup, and before receiving input tuples. It lets you initialize fields. You are free to implement this method for example to initialize static or regular fields of your punchlet.

Overrides:

activate in class Punchlets

addBlock

public void addBlock(List<PunchletSequence> punchlets,
                     String affinity)

add

public void add(List<Punchlet> punchlets,
                String affinity)

Add a punchlet to the list

Parameters:

punchlet - the additional punchlet

executors -

affinity -

__isChained

public boolean __isChained()

some punchlet are made of a chain of several punchlets.

Overrides:

__isChained in class Punchlets

Returns:

true is this punchlet is a chained one

execute

public void execute(Tuple root)

Description copied from class: PunchletContext

Execute the punchlet. Every punchlet implement this method. This is usually not visible to punch programmer as they write simple punchlet providing only a block of instructions, i.e

 {
        [es_type] = \"apache\";
 }
 

These simple punchlet are compiled into a running punchlet implementing this class.

Note that a punchlet can be injected with additional json resource tuples, i.e. tuple that hold the content of static json files, containing configuration data. These are automatically injected as fields in your punchlet.

Overrides:

execute in class PunchletContext

Parameters:

root - the root tuple. This one is mandatory

execute

public void execute(Tuple root,
                    org.thales.punch.api.IReceiver<Tuple> receiver)

Execute a chain of punchlet starting from a specific one.

Parameters:

root - the root document to pass to that punchlet and the subsequent ones.

receiver -

run

public void run()

Specified by:

run in interface Runnable

getQueueNum

public static int getQueueNum(LinkedBlockingQueue<Tuple> q)