WPILibC++  2018.4.1-20180824234721-1176-gd6d5321
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
wpi::uv::ProcessOptions Class Referencefinal

Process options. More...

#include <Process.h>

Public Member Functions

ProcessOptionsSetEnv (char **env)
 Set environment variables for the subprocess. More...
 
ProcessOptionsSetCwd (const Twine &cwd)
 Set the current working directory for the subprocess. More...
 
ProcessOptionsSetUid (uv_uid_t uid) noexcept
 Set the child process' user id. More...
 
ProcessOptionsSetGid (uv_gid_t gid) noexcept
 Set the child process' group id. More...
 
ProcessOptionsSetFlags (unsigned int flags) noexcept
 Set flags. More...
 
ProcessOptionsClearFlags (unsigned int flags) noexcept
 Clear flags. More...
 
ProcessOptionsStdioIgnore (size_t index)
 Explicitly ignore a stdio. More...
 
ProcessOptionsStdioInherit (size_t index, int fd)
 Inherit a file descriptor from the parent process. More...
 
ProcessOptionsStdioInherit (size_t index, Pipe &pipe)
 Inherit a pipe from the parent process. More...
 
ProcessOptionsStdioCreatePipe (size_t index, Pipe &pipe, unsigned int flags)
 Create a pipe between the child and the parent. More...
 

Friends

class Process
 

Detailed Description

Process options.

Member Function Documentation

ProcessOptions& wpi::uv::ProcessOptions::ClearFlags ( unsigned int  flags)
inlinenoexcept

Clear flags.

Parameters
flagsBitmask values from uv_process_flags.
ProcessOptions& wpi::uv::ProcessOptions::SetCwd ( const Twine cwd)
inline

Set the current working directory for the subprocess.

Parameters
cwdcurrent working directory
ProcessOptions& wpi::uv::ProcessOptions::SetEnv ( char **  env)
inline

Set environment variables for the subprocess.

If not set or set to nullptr, the parent's environment is used.

Parameters
envenvironment variables
ProcessOptions& wpi::uv::ProcessOptions::SetFlags ( unsigned int  flags)
inlinenoexcept

Set flags.

Parameters
flagsBitmask values from uv_process_flags.
ProcessOptions& wpi::uv::ProcessOptions::SetGid ( uv_gid_t  gid)
inlinenoexcept

Set the child process' group id.

Parameters
gidgroup id
ProcessOptions& wpi::uv::ProcessOptions::SetUid ( uv_uid_t  uid)
inlinenoexcept

Set the child process' user id.

Parameters
uiduser id
ProcessOptions& wpi::uv::ProcessOptions::StdioCreatePipe ( size_t  index,
Pipe pipe,
unsigned int  flags 
)

Create a pipe between the child and the parent.

Parameters
indexstdio index
pipepipe
flagsSome combination of UV_READABLE_PIPE, UV_WRITABLE_PIPE, and UV_OVERLAPPED_PIPE (Windows only, ignored on Unix).
ProcessOptions& wpi::uv::ProcessOptions::StdioIgnore ( size_t  index)

Explicitly ignore a stdio.

Parameters
indexstdio index
ProcessOptions& wpi::uv::ProcessOptions::StdioInherit ( size_t  index,
int  fd 
)

Inherit a file descriptor from the parent process.

Parameters
indexstdio index
fdparent file descriptor
ProcessOptions& wpi::uv::ProcessOptions::StdioInherit ( size_t  index,
Pipe pipe 
)

Inherit a pipe from the parent process.

Parameters
indexstdio index
pipepipe

The documentation for this class was generated from the following file: