pipe
)Manage Murex named pipes
pipe
creates and destroys Murex named pipes.
pipe name [ pipe-type ]
!pipe name
pipe example
!pipe example
Create a TCP pipe (deleting a pipe is the same regardless of the type of pipe):
pipe example --tcp-dial google.com:80
bg { <example> }
out "GET /" -> <example>
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
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.
pipe
!pipe
bg
): Run processes in the backgroundmatch
): Match an exact value in an arrayout
): Print a string to the stdout with a trailing new line character<pipe>
): Reads from a Murex named pipe<pipe>
): Reads from a Murex named pipe<stdin>
): Read the stdin belonging to the parent code blockruntime
): Returns runtime information on the internal state of Murextest
): Murex’s test framework - define tests, run tests and debug shell scriptsThis document was generated from builtins/core/pipe/pipe_doc.yaml.
This site's content is rebuilt automatically from murex's source code after each merge to the master
branch. Downloadable murex binaries are also built with the website.
Last built on Wed Sep 18 21:18:57 UTC 2024 against commit c037883c03788357164e9846c84d9f777251495d9452a8e.
Current version is 6.3.4225 (develop) which has been verified against tests cases.