<pipe> Read Named Pipe
<pipe>
Read Named Pipe
Reads from a Murex named pipe
Description
Sometimes you will need to start a command line with a Murex named pipe, eg
» <namedpipe> -> match foobar
See the documentation on
pipe
for more details about Murex named pipes.
Usage
Read from pipe
<namedpipe> -> <stdout>
Write to pipe
<stdin> -> <namedpipe>
Examples
» pipe example
» bg { <example> -> match 2 }
» a <example> [1..3]
2
» !pipe example
Detail
What are Murex named pipes?
In POSIX, there is a concept of stdin, stdout and stderr, these are FIFO files while are "piped" from one executable to another. ie stdout for application 'A' would be the same file as stdin for application 'B' when A is piped to B: A | B
. Murex adds a another layer around this to enable support for passing data types and builtins which are agnostic to the data serialization format traversing the pipeline. While this does add overhead the advantage is this new wrapper can be used as a primitive for channelling any data from one point to another.
Murex named pipes are where these pipes are created in a global store, decoupled from any executing functions, named and can then be used to pass data along asynchronously.
For example
pipe example
bg {
<example> -> match Hello
}
out "foobar" -> <example>
out "Hello, world!" -> <example>
out "foobar" -> <example>
!pipe example
This returns Hello, world!
because out
is writing to the example named pipe and match
is also reading from it in the background (bg
).
Named pipes can also be inlined into the command parameters with <>
tags
pipe example
bg {
<example> -> match: Hello
}
out <example> "foobar"
out <example> "Hello, world!"
out <example> "foobar"
!pipe example
Please note this is also how
test
works.
Murex named pipes can also represent network sockets, files on a disk or any other read and/or write endpoint. Custom builtins can also be written in Golang to support different abstractions so your Murex code can work with those read or write endpoints transparently.
To see the different supported types run
runtime --pipes
Namespaces and usage in modules and packages
Pipes created via pipe
are created in the global namespace. This allows pipes to be used across different functions easily however it does pose a risk with name clashes where Murex named pipes are used heavily. Thus is it recommended that pipes created in modules should be prefixed with the name of its package.
Synonyms
(murex named pipe)
<>
read-named-pipe
See Also
<stdin>
: Read the stdin belonging to the parent code blocka
(mkarray): A sophisticated yet simple way to build an array or listbg
: Run processes in the backgroundja
(mkarray): A sophisticated yet simply way to build a JSON arraypipe
: Manage Murex named pipesruntime
: Returns runtime information on the internal state of Murex
This document was generated from builtins/core/pipe/namedpipe_doc.yaml.