What is Piping?
Piping is a simple library for Common Lisp to construct message-passing systems in a form similar to pipelines.
How To
Load Piping with ASDF or Quicklisp.
(ql:quickload :piping)
Create a new pipeline:
(setf pipeline
(make-instance 'pipeline
:source (build-pipeline (make-instance 'source)
(valve :name "MAIN-VALVE")
(print-faucet :name "PRINTER"))))Pass a message along it:
(pass pipeline "Hello Plumbers!")
Print the pipeline, retrieve a segment and change it:
(print-flow pipeline *standard-output*)(close-valve (get-pipe pipeline "MAIN-VALVE"))
Pipe systems are still a bit complicated to build and handle. I'm intending on reworking this in the future to make it simple to build and manipulate on the fly.
Other Guff
Piping is a sub-project of TyNETv5 ("Radiance"), licensed under the Artistic License 2.0 and ©2013 TymoonNET/NexT, Nicolas Hafner.
This program can be obtained via git on git://git.tymoon.eu/piping.git. For questions, patches or suggestions, please contact me via email.
Package Function Index
-
EXTERNAL GENERIC ACTIVE
(SB-PCL::OBJECT) -
EXTERNAL CLASS ACTIVE-SWITCH
A switch that can actively change its target pipe depending on the message.
-
EXTERNAL CLASS ACTIVE-VALVE
An active valve that closes or opens depending on specific messages.
-
EXTERNAL GENERIC ADD-PIPE
(PIPELINE CLASS-OR-INSTANCE &REST ARGS) -
EXTERNAL MACRO BUILD-PIPELINE
(SOURCE &BODY PIPES) -
EXTERNAL GENERIC CLOSE-FUNC
(SB-PCL::OBJECT) -
EXTERNAL GENERIC CLOSE-VALVE
(VALVE &OPTIONAL (STATUS)) -
EXTERNAL GENERIC CONNECT-NEW
(SPLITTER SEGMENT)Connect a new element to the splitter.
-
EXTERNAL GENERIC CONNECT-NEXT
(PIPE SEGMENT)Connect the pipe's next with the given segment.
-
EXTERNAL GENERIC CONNECT-PREV
(PIPE SEGMENT)Connect the pipe's previous with the given segment.
-
EXTERNAL GENERIC DISCONNECT
(SPLITTER SEGMENT)Disconnect an existing element from the splitter.
-
EXTERNAL GENERIC DISCONNECT-NEXT
(PIPE)Disconnect the next segment.
-
EXTERNAL GENERIC DISCONNECT-PREV
(PIPE)Disconnect the previous segment.
-
EXTERNAL CLASS FAUCET
An endpoint for pipe messages to arrive at.
-
EXTERNAL CLASS FILE-FAUCET
A faucet that prints everything to file.
-
EXTERNAL CLASS FILTER
Pipe segment that filters messages according to a test function.
-
EXTERNAL GENERIC GET-PIPE
(PIPELINE NAME) -
EXTERNAL GENERIC INSERT-AFTER
(PIPE PIPE-TO-INSERT)Insert a new pipe element in between this and the one after.
-
EXTERNAL GENERIC INSERT-BEFORE
(PIPE PIPE-TO-INSERT)Insert a new pipe element in between this and the one before.
-
EXTERNAL GENERIC MAKE-ACTIVE
(SWITCH SEGMENT-OR-INDEX &KEY (TEST #'EQL))Makes the given segment or index active.
-
EXTERNAL GENERIC MESSAGE
(CONDITION) -
EXTERNAL GENERIC MIX
(SB-PCL::OBJECT) -
EXTERNAL CLASS MIXER
A pipe segment that actively changes components of the message.
-
EXTERNAL GENERIC NAME
(SB-PCL::OBJECT) -
EXTERNAL GENERIC NEXT
(SB-PCL::OBJECT) -
EXTERNAL GENERIC ON-CLOSED
(SB-PCL::OBJECT) -
EXTERNAL GENERIC OPEN-FUNC
(SB-PCL::OBJECT) -
EXTERNAL GENERIC OPEN-VALVE
(VALVE &OPTIONAL (STATUS)) -
EXTERNAL GENERIC OPENED
(SB-PCL::OBJECT) -
EXTERNAL GENERIC PASS
(SEGMENT MESSAGE)Pass a message through the segment.
-
EXTERNAL CLASS PIPE
Base pipe class.
-
EXTERNAL CLASS PIPELINE
A class to hold easy access to pipe segments and the pipe system as a whole.
-
EXTERNAL GENERIC PIPES
(SB-PCL::OBJECT) -
EXTERNAL GENERIC PREV
(SB-PCL::OBJECT) -
EXTERNAL CLASS PRINT-FAUCET
A faucet that simply prints all the messages to stdout
-
EXTERNAL GENERIC PRINT-FLOW
(PIPE STREAM)Print this and all following pipes as a flow diagram.
-
EXTERNAL GENERIC PRINT-SELF
(SEGEMENT STREAM)Print a representation of itself without connecting segments.
-
EXTERNAL GENERIC REMOVE-AFTER
(PIPE)Pop out the element after this one and return it. Tries to retain the pipeline.
-
EXTERNAL GENERIC REMOVE-BEFORE
(PIPE)Pop out the element before this one and return it. Tries to retain the pipeline.
-
EXTERNAL GENERIC REMOVE-THIS
(PIPE)Pop out this pipe element and return it. Tries to retain the pipeline.
-
EXTERNAL GENERIC REPLACE-THIS
(PIPE PIPE-TO-INSERT)Replace this pipe element with the given one and return the old one.
-
EXTERNAL CLASS SEGMENT
Base segment class.
-
EXTERNAL CLASS SOURCE
A source for the pipe system that feeds messages down the pipeline.
-
EXTERNAL GENERIC SOURCE
(SB-PCL::OBJECT) -
EXTERNAL CLASS SPLITTER
Splits the messages up and passes them to multiple targets.
-
EXTERNAL CLASS STRING-STREAM-FAUCET
A faucet that prints everything to a string stream.
-
EXTERNAL CLASS SWITCH
A switch connects to multiple pipes but only passes to one.
-
EXTERNAL GENERIC TARGETS
(SB-PCL::OBJECT) -
EXTERNAL GENERIC TEST
(SB-PCL::OBJECT) -
EXTERNAL CLASS VALVE
Valves allow you to regulate the passing process.
-
EXTERNAL GENERIC VALVE
(CONDITION) -
EXTERNAL CLASS VALVE-CLOSED
Condition signalled when a message arrives at a closed valve.