pipe - Command Reference

Manage Murex named pipes

Description

pipe creates and destroys Murex named pipes.

Usage

Create pipe

pipe: name [ pipe-type ]

Destroy pipe

!pipe: name

Examples

Create a standard pipe:

pipe: example

Delete a pipe:

!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>

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

See Also

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 Fri May 19 22:45:48 UTC 2023 against commit 54b5f6754b5f67b250bbf7353e83c42ed187802584c3ae3.

Current version is 4.1.6140 which has been verified against 14045 tests cases.