github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/gen/user-guide/named-pipes_doc.yaml (about)

     1  - DocumentID: namedpipes
     2    Title: >-
     3      Named Pipes
     4    CategoryID: user-guide
     5    Summary: >-
     6      A detailed breakdown of named pipes in Murex
     7    Description: |-
     8      ## Background
     9  
    10      [Wikipedia describes](https://en.wikipedia.org/wiki/Named_pipe) a named pipe as the following:
    11  
    12      > In computing, a named pipe (also known as a FIFO for its behavior) is an
    13      > extension to the traditional pipe concept on Unix and Unix-like systems, and
    14      > is one of the methods of inter-process communication (IPC). The concept is
    15      > also found in OS/2 and Microsoft Windows, although the semantics differ
    16      > substantially. A traditional pipe is "unnamed" and lasts only as long as the
    17      > process. A named pipe, however, can last as long as the system is up, beyond
    18      > the life of the process. It can be deleted if no longer used. Usually a named
    19      > pipe appears as a file, and generally processes attach to it for IPC.
    20  
    21      Where Murex differs from standard Linux/UNIX is that named pipes are not
    22      special files but rather an object or construct within the shell runtime. This
    23      allows for more user friendly tooling and syntactic sugar to implemented around
    24      it while largely still having the same functionality as a more traditional file
    25      based named pipe.
    26  
    27      ## In Murex
    28  
    29      In Murex, named pipes are described in code as a value inside angle brackets.
    30      There are four named pipes pre-configured: `<in>` (STDIN), `<out>` (STDOUT),
    31      `<err>` (STDERR), and `<null>` (/dev/null equivalent).
    32  
    33      You can call a named pipe as either a method, function, or parameter.
    34  
    35      **As a method:**
    36  
    37      ```
    38      <in> -> command parameter1 parameter2 parameter3
    39      ```
    40  
    41      **As a function:**
    42  
    43      ```
    44      command parameter1 parameter2 parameter3 -> <out>
    45      ```
    46  
    47      **As a parameter:**
    48  
    49      ```
    50      command <out> <!err> parameter1 parameter2 parameter3
    51      ```
    52  
    53    Synonyms:
    54    Related:
    55    - namedpipe
    56    - stdin
    57    - test