#include <connection.h>
Inherits TQObject.
Public Member Functions | |
Connection () | |
void | init (TDESocket *sock) |
void | init (int fd_in, int fd_out) |
void | connect (TQObject *receiver=0, const char *member=0) |
void | close () |
int | fd_from () const |
int | fd_to () const |
bool | inited () const |
void | send (int cmd, const TQByteArray &arr=TQByteArray()) |
bool | sendnow (int _cmd, const TQByteArray &data) |
int | read (int *_cmd, TQByteArray &data) |
void | suspend () |
void | resume () |
bool | suspended () const |
Protected Slots | |
void | dequeue () |
Detailed Description
This class provides a simple means for IPC between two applications via a pipe.
It handles a queue of commands to be sent which makes it possible to queue data before an actual connection has been established.
Definition at line 48 of file connection.h.
Constructor & Destructor Documentation
◆ Connection()
Connection::Connection | ( | ) |
Member Function Documentation
◆ close()
void Connection::close | ( | ) |
Closes the connection.
Definition at line 86 of file connection.cpp.
◆ fd_from()
|
inline |
Returns the input file descriptor.
- Returns
- the input file descriptor
Definition at line 81 of file connection.h.
◆ fd_to()
|
inline |
Returns the output file descriptor.
- Returns
- the output file descriptor
Definition at line 86 of file connection.h.
◆ init() [1/2]
void Connection::init | ( | int | fd_in, |
int | fd_out | ||
) |
Initialize the connection to use the given file descriptors.
- Parameters
-
fd_in the input file descriptor to use fd_out the output file descriptor to use
- See also
- inited()
Definition at line 151 of file connection.cpp.
◆ init() [2/2]
void Connection::init | ( | TDESocket * | sock | ) |
Initialize this connection to use the given socket.
- Parameters
-
sock the socket to use
- See also
- inited()
Definition at line 131 of file connection.cpp.
◆ inited()
|
inline |
Checks whether the connection has been initialized.
- Returns
- true if the initialized
- See also
- init()
Definition at line 93 of file connection.h.
◆ read()
int Connection::read | ( | int * | _cmd, |
TQByteArray & | data | ||
) |
Receive data.
- Parameters
-
_cmd the received command will be written here data the received data will be written here
- Returns
- >=0 indicates the received data size upon success -1 indicates error
Definition at line 216 of file connection.cpp.
◆ resume()
void Connection::resume | ( | ) |
Resume handling of incoming data.
Definition at line 79 of file connection.cpp.
◆ send()
void Connection::send | ( | int | cmd, |
const TQByteArray & | arr = TQByteArray() |
||
) |
Sends/queues the given command to be sent.
- Parameters
-
cmd the command to set arr the bytes to send
Definition at line 105 of file connection.cpp.
◆ sendnow()
bool Connection::sendnow | ( | int | _cmd, |
const TQByteArray & | data | ||
) |
Sends the given command immediately.
- Parameters
-
_cmd the command to set data the bytes to send
- Returns
- true if successful, false otherwise
Definition at line 182 of file connection.cpp.
◆ suspend()
void Connection::suspend | ( | ) |
Don't handle incoming data until resumed.
Definition at line 72 of file connection.cpp.
◆ suspended()
|
inline |
Returns status of connection.
- Returns
- true if suspended, false otherwise
Definition at line 134 of file connection.h.
The documentation for this class was generated from the following files: