[#BloombergLP-bdls-PipeUtil]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdls.adoc[bdls]::PipeUtil
:relfileprefix: ../../
:mrdocs:

This struct contains utility methods for platform&hyphen;independent named pipe operations&period;

== Synopsis

Declared in `&lt;bdls&lowbar;pipeutil&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct PipeUtil;
----

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdls/PipeUtil/isOpenForReading.adoc[`isOpenForReading`] 
| Return `true` if the pipe with the specified UTF&hyphen;8 `pipeName` exists, the calling process has permission to write to it, and some process is able to read the bytes written to it, and `false` otherwise&period; On Windows, this function may block and may write an &quot;empty message&quot;, consisting of a single newline&period; The behavior is undefined unless `pipeName` is a valid UTF&hyphen;8 string&period; Note that even though a process might have the pipe open for reading, this function might still return `false` because there are not sufficient resources available&period;
| xref:BloombergLP/bdls/PipeUtil/makeCanonicalName-05.adoc[`makeCanonicalName`] 
| Load into the specified `pipeName` the system&hyphen;dependent canonical pipe name corresponding to the specified `baseName`&period; Return 0 on success, and a nonzero value if `baseName` cannot be part of a pipe name on this system&period;
| xref:BloombergLP/bdls/PipeUtil/send.adoc[`send`] 
| Send the specified `message` to the pipe with the specified UTF&hyphen;8 `pipeName`&period; Return 0 on success, and a nonzero value otherwise&period; `message is output in a single `write&apos; operation&semi; consequently, messages that do not exceed the `PIPE&lowbar;BUF` value (see &lsqb;&rsqb;Atomicity) will not be interleaved even when multiple concurrent processes are writing to `pipeName`&period; The behavior is undefined unless `pipeName` is a valid UTF&hyphen;8 string&period;
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#
