[#TokenPipe]
= TokenPipe
:mrdocs:

An interprocess or interthread pipe for sending tokens (one‐byte values) over.

== Synopsis

Declared in `<util/tokenpipe.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class TokenPipe;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:TokenPipe/2constructor-08.adoc[`TokenPipe`]         [.small]#[constructor]#
| Constructors
| xref:TokenPipe/2destructor.adoc[`~TokenPipe`] [.small]#[destructor]#
| Closes any pipe end that has not been moved out.
| xref:TokenPipe/operator_assign-0d.adoc[`operator=`] 
| Assignment operators
| xref:TokenPipe/Close.adoc[`Close`] 
| Close and end of the pipe that hasn't been moved out.
| xref:TokenPipe/TakeReadEnd.adoc[`TakeReadEnd`] 
| Take the read end of this pipe. This can only be called once, as the object will be moved out.
| xref:TokenPipe/TakeWriteEnd.adoc[`TakeWriteEnd`] 
| Take the write end of this pipe. This should only be called once, as the object will be moved out.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:TokenPipe/Make.adoc[`Make`] 
| Create a new pipe.
|===



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