pipe¶
-
class
uv.pipe(ipc)¶ Construct a new named pipe.
Arguments: - ipc (bool) – A toggle for if this pipe is going to be used for IPC.
Note
The
Streamobject methods also apply here.-
uv.pipe.bind(path)¶ Bind the pipe to a named pipe/path.
Arguments: - path (string) – Path, or the named pipe.
-
uv.pipe.open(fd)¶ Open the pipe on an existing file descriptor or HANDLE.
Arguments: - fd (int) – The file descriptor to open the
Pipeon.
Throws: If unable to open the pipe on said file descriptor.
- fd (int) – The file descriptor to open the
-
uv.pipe.connect(pipe)¶ Connect to the named pipe/socket.
Arguments: - pipe (string) – The named pipe to connect to.
-
uv.pipe.getsockname()¶ Get the name of the socket.
Returns: A string representing the name of the socket/pipe.
-
uv.pipe.getpeername()¶ Get the name of the named pipe that the pipe is connected to.
Returns: A string representing the name of the peer.
-
uv.pipe.pending_instances(count)¶ Set the number of pending pipe instance handles when the pipe server is waiting for connections.
Arguments: - count (int) – Number of pending pipe instance handles.
-
uv.pipe.pending_count()¶ Get pending count of pipe. Used to transmit types.
Returns: An integer representing the pending count of handles.
-
uv.pipe.pending_type()¶ Get pending type of handle being transmitted.
Returns: An integer representing the type to be transmitted.
-
uv.pipe.chmod(flags)¶ Alter pipe permissions.
Arguments: - flags (int) – The flags that should now be set to the pipe.