GATE
gate_process_stream_t Interface Reference

A stream object representing the IO pipes to a running process. More...

#include <processes.h>

Inheritance diagram for gate_process_stream_t:
gate_resourcestream_t gate_stream_t gate_object_t

Public Member Functions

gate_result_t read_err (char *buffer, gate_size_t bufferlength, gate_size_t *returned)
 Reads data from ERR-output-stream generated in the processes.
 
- Public Member Functions inherited from gate_resourcestream_t
gate_result_t get_resource (gate_int32_t resource_type, gate_uintptr_t *resource_handle)
 Returns a resouce handle to the requested resource type (GATE_STREAM_RESOURCE_*)
 
- Public Member Functions inherited from gate_stream_t
gate_result_t read (char *buffer, gate_size_t bufferlength, gate_size_t *returned)
 Read bytes from stream and stores them in the given buffer.
 
gate_result_t peek (char *buffer, gate_size_t bufferlength, gate_size_t *returned)
 Tries to read bytes from the stream, but leaves them in its input buffer to be read again.
 
gate_result_t write (char const *buffer, gate_size_t bufferlength, gate_size_t *written)
 Writes bytes from the given buffer into the stream.
 
gate_result_t flush ()
 Instructs the stream to flush its internal buffers and make current status persistent.
 
- Public Member Functions inherited from gate_object_t
char const * get_interface_name ()
 Returns on object's interface path name.
 
void release ()
 Decrease object's reference counter, releases the object when count reaches zero.
 
int retain ()
 Increase object's reference counter.
 

Detailed Description

A stream object representing the IO pipes to a running process.

Member Function Documentation

◆ read_err()

gate_result_t read_err ( char * buffer,
gate_size_t bufferlength,
gate_size_t * returned )

Reads data from ERR-output-stream generated in the processes.

Parameters
[in]bufferPointer to buffer receiving ERR data content
[in]bufferlengthCapacity of buffer in bytes
[out]returnedPointer to variable receiving the amount of bytes retrieved from ERR stream
Returns
GATE_RESULT_* result code

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