CrossClj

0.1.4 docs

SourceDocs



RECENT
    VARS
    ->Processor
    cache-server
    deftransform
    event-processing-channel
    event-processing-xform
    map->Processor
    metrics-log-passthrough
    new-processor
    new-streamsum
    noop-metrics
    read-config-file
    validate-config
    wrap-channel-with-queues

    « Index of all namespaces of this project

    (->Processor in-q out-q config processing-channel caches-component metrics-component output-encoder)
    Positional factory function for class streamsum.system.Processor.
    
    (cache-server streamsum)
    macro
    (deftransform name & patterns)
    Returns a unary function transforming a 4-tuple into a sequence of zero or more 4-tuples.  The transformation is specified using the pattern matching syntax of core.match.
    
    (event-processing-channel caches-component metrics-component tuple-xform output-encoder)
    Returns an unbuffered channel that will perform the full event transformation.
    Exceptions will be logged and exception-causing transformations will be dropped.
    (event-processing-xform caches-component metrics-component tuple-xform output-encoder)
    Returns a transducer that performs the full event transformation.
    
    (map->Processor m__7585__auto__)
    Factory function for class streamsum.system.Processor, taking a map of keywords to field values.
    
    (metrics-log-passthrough metrics-component metric-key v)
    Log that a value passed through the given processing stage and pass through value
    
    (new-processor config in-q out-q output-encoder)
    Factory function for Processor component.
    
    (new-streamsum filepath-or-map in-q out-q)(new-streamsum filepath-or-map in-q out-q metrics-component cache-server)(new-streamsum filepath-or-map in-q out-q metrics-component cache-server output-encoder)
    Factory function instantiating a new streamsum processing pipeline.  Use the start/stop functions of the Lifecycle protocol to control the pipeline's lifecycle.  
    
    filepath-or-map: Pass configuration as a map, or as a path string to a configuration file.
    in-q: BlockingQueue supplying input objects
    out-q: Blocking queue onto which output objects will be pushed
    cache-server: Pass an implementation of the CacheServer protocol.  Default uses Clojure maps.
    metrics-component: Implementation of the Metrics protocol (optional).
    output-encoder: Implementation of the Encode protocol (optional).  Default output format is a vector [cache-key key val time].
    
    (read-config-file param-file-name)
    Reads the config file.  Returns the configuraiton map.
    
    (validate-config config)
    (wrap-channel-with-queues channel in-q out-q)
    Wire an input queue and an output queue to the channel.
    Note that if the output queue is full, it will exert back-pressure on the upstream processing.
    Put :shutdown on in-q to terminate the threads and close the channel.