WPILibC++
2019.2.1-24-g74f7ba0
|
TTY handle. More...
#include <Tty.h>
Public Member Functions | |
Tty (const private_init &) | |
void | SetMode (uv_tty_mode_t mode) |
Set the TTY using the specified terminal mode. More... | |
void | ResetMode () |
Reset TTY settings to default values for the next process to take over. More... | |
std::pair< int, int > | GetWindowSize () |
Gets the current window size. More... | |
![]() | |
std::shared_ptr< Tty > | shared_from_this () |
std::shared_ptr< const Tty > | shared_from_this () const |
uv_tty_t * | GetRaw () const noexcept |
Get the underlying handle data structure. More... | |
![]() | |
std::shared_ptr< Stream > | shared_from_this () |
std::shared_ptr< const Stream > | shared_from_this () const |
void | Shutdown (const std::shared_ptr< ShutdownReq > &req) |
Shutdown the outgoing (write) side of a duplex stream. More... | |
void | Shutdown (std::function< void()> callback=nullptr) |
Shutdown the outgoing (write) side of a duplex stream. More... | |
void | StartRead () |
Start reading data from an incoming stream. More... | |
void | StopRead () |
Stop reading data from the stream. More... | |
void | Write (ArrayRef< Buffer > bufs, const std::shared_ptr< WriteReq > &req) |
Write data to the stream. More... | |
void | Write (ArrayRef< Buffer > bufs, std::function< void(MutableArrayRef< Buffer >, Error)> callback) |
Write data to the stream. More... | |
int | TryWrite (ArrayRef< Buffer > bufs) |
Queue a write request if it can be completed immediately. More... | |
bool | IsReadable () const noexcept |
Check if the stream is readable. More... | |
bool | IsWritable () const noexcept |
Checks if the stream is writable. More... | |
bool | SetBlocking (bool enable) noexcept |
Enable or disable blocking mode for a stream. More... | |
size_t | GetWriteQueueSize () const noexcept |
Gets the amount of queued bytes waiting to be sent. More... | |
uv_stream_t * | GetRawStream () const noexcept |
Get the underlying stream data structure. More... | |
![]() | |
Handle (const Handle &)=delete | |
Handle (Handle &&)=delete | |
Handle & | operator= (const Handle &)=delete |
Handle & | operator= (Handle &&)=delete |
Type | GetType () const noexcept |
Get the type of the handle. More... | |
StringRef | GetTypeName () const noexcept |
Get the name of the type of the handle. More... | |
std::shared_ptr< Loop > | GetLoop () const noexcept |
Get the loop where this handle runs. More... | |
Loop & | GetLoopRef () const noexcept |
Get the loop where this handle runs. More... | |
bool | IsActive () const noexcept |
Check if the handle is active. More... | |
bool | IsClosing () const noexcept |
Check if a handle is closing or closed. More... | |
void | Close () noexcept |
Request handle to be closed. More... | |
void | Reference () noexcept |
Reference the given handle. More... | |
void | Unreference () noexcept |
Unreference the given handle. More... | |
bool | HasReference () const noexcept |
Check if the given handle is referenced. More... | |
size_t | RawSize () const noexcept |
Return the size of the underlying handle type. More... | |
uv_handle_t * | GetRawHandle () const noexcept |
Get the underlying handle data structure. More... | |
void | SetBufferAllocator (std::function< Buffer(size_t)> alloc, std::function< void(Buffer &)> dealloc) |
Set the functions used for allocating and releasing buffers. More... | |
void | FreeBuf (Buffer &buf) const noexcept |
Free a buffer. More... | |
template<typename T = void> | |
std::shared_ptr< T > | GetData () const |
Gets user-defined data. More... | |
void | SetData (std::shared_ptr< void > data) |
Sets user-defined data. More... | |
void | ReportError (int err) |
Report an error. More... | |
Static Public Member Functions | |
static std::shared_ptr< Tty > | Create (Loop &loop, uv_file fd, bool readable) |
Create a TTY handle. More... | |
static std::shared_ptr< Tty > | Create (const std::shared_ptr< Loop > &loop, uv_file fd, bool readable) |
Create a TTY handle. More... | |
Additional Inherited Members | |
![]() | |
using | Type = uv_handle_type |
![]() | |
sig::Signal< Buffer &, size_t > | data |
Signal generated when data was read on a stream. | |
sig::Signal | end |
Signal generated when no more read data is available. | |
![]() | |
sig::Signal< Error > | error |
Error signal. | |
sig::Signal | closed |
Closed signal. | |
![]() | |
Stream (uv_stream_t *uv_stream) | |
![]() | |
Handle (uv_handle_t *uv_handle) | |
void | Keep () noexcept |
void | Release () noexcept |
void | ForceClosed () noexcept |
template<typename F , typename... Args> | |
bool | Invoke (F &&f, Args &&...args) |
![]() | |
static void | AllocBuf (uv_handle_t *handle, size_t size, uv_buf_t *buf) |
static void | DefaultFreeBuf (Buffer &buf) |
TTY handle.
TTY handles represent a stream for the console.
Create a TTY handle.
loop | Loop object where this handle runs. |
fd | File descriptor, usually 0=stdin, 1=stdout, 2=stderr |
readable | Specifies if you plan on calling StartRead(). stdin is readable, stdout is not. |
|
inlinestatic |
Create a TTY handle.
loop | Loop object where this handle runs. |
fd | File descriptor, usually 0=stdin, 1=stdout, 2=stderr |
readable | Specifies if you plan on calling StartRead(). stdin is readable, stdout is not. |
|
inline |
Gets the current window size.
|
inline |
Reset TTY settings to default values for the next process to take over.
Typically called when the program exits.
|
inline |
Set the TTY using the specified terminal mode.
mode | terminal mode |