#include <kclientsocketbase.h>

Public Types | |
enum | SocketState { Idle, HostLookup, HostFound, Bound, Connecting, Open, Closing, Unconnected = Bound, Connected = Open, Connection = Open } |
Signals | |
void | stateChanged (int newstate) |
void | gotError (int code) |
void | hostFound () |
void | bound (const KResolverEntry &local) |
void | aboutToConnect (const KResolverEntry &remote, bool &skip) |
void | connected (const KResolverEntry &remote) |
void | closed () |
void | readyRead () |
void | readyWrite () |
Public Member Functions | |
KClientSocketBase (TQObject *parent, const char *name) | |
virtual | ~KClientSocketBase () |
SocketState | state () const |
KResolver & | peerResolver () const |
const KResolverResults & | peerResults () const |
KResolver & | localResolver () const |
const KResolverResults & | localResults () const |
void | setResolutionEnabled (bool enable) |
void | setFamily (int families) |
virtual bool | lookup () |
virtual bool | bind (const TQString &node=TQString::null, const TQString &service=TQString::null)=0 |
virtual bool | bind (const KResolverEntry &address) |
virtual bool | connect (const TQString &node=TQString::null, const TQString &service=TQString::null)=0 |
virtual bool | connect (const KResolverEntry &address) |
void | connectToHost (const TQString &host, TQ_UINT16 port) |
virtual bool | disconnect () |
virtual bool | open (TQ_OpenMode) |
virtual void | close () |
virtual void | flush () |
virtual TQ_LONG | waitForMore (int msecs, bool *timeout=0L) |
virtual TQT_TQIO_LONG | tqreadBlock (char *data, TQT_TQIO_ULONG maxlen) |
virtual TQT_TQIO_LONG | tqreadBlock (char *data, TQT_TQIO_ULONG maxlen, KSocketAddress &from) |
virtual TQ_LONG | peekBlock (char *data, TQ_ULONG maxlen) |
virtual TQ_LONG | peekBlock (char *data, TQ_ULONG maxlen, KSocketAddress &from) |
virtual TQT_TQIO_LONG | tqwriteBlock (const char *data, TQT_TQIO_ULONG len) |
virtual TQT_TQIO_LONG | tqwriteBlock (const char *data, TQT_TQIO_ULONG len, const KSocketAddress &to) |
virtual KSocketAddress | localAddress () const |
virtual KSocketAddress | peerAddress () const |
bool | emitsReadyRead () const |
virtual void | enableRead (bool enable) |
bool | emitsReadyWrite () const |
virtual void | enableWrite (bool enable) |
Protected Slots | |
virtual void | slotReadActivity () |
virtual void | slotWriteActivity () |
Protected Member Functions | |
virtual bool | setSocketOptions (int opts) |
void | setState (SocketState state) |
virtual void | stateChanging (SocketState newState) |
void | copyError () |
Detailed Description
Abstract client socket class.
This class provides the base functionality for client sockets, such as, and especially, name resolution and signals.
- Note:
- This class is abstract. If you're looking for a normal, client socket class, see KStreamSocket and KBufferedSocket
Definition at line 53 of file kclientsocketbase.h.
Member Enumeration Documentation
Socket states.
These are the possible states for a KClientSocketBase:
- Idle: socket is not connected
- HostLookup: socket is doing host lookup prior to connecting
- HostFound: name lookup is complete
- Bound: the socket is locally bound
- Connecting: socket is attempting connection
- Open: socket is open
- Connected (=Open): socket is connected
- Connection (=Open): yet another name for a connected socket
- Closing: socket is shutting down
Whenever the socket state changes, the stateChanged(int) signal will be emitted.
Definition at line 81 of file kclientsocketbase.h.
Constructor & Destructor Documentation
KClientSocketBase::KClientSocketBase | ( | TQObject * | parent, |
const char * | name | ||
) |
Default constructor.
- Parameters:
-
parent the parent TQObject object name the name of this object
Definition at line 50 of file kclientsocketbase.cpp.
KClientSocketBase::~KClientSocketBase | ( | ) | [virtual] |
Destructor.
Definition at line 66 of file kclientsocketbase.cpp.
Member Function Documentation
void KNetwork::KClientSocketBase::aboutToConnect | ( | const KResolverEntry & | remote, |
bool & | skip | ||
) | [signal] |
This signal is emitted when the socket is about to connect to an address (but before doing so).
The skip
parameter can be used to make the loop skip this address. Its value is initially false: change it to true if you want to skip the current address (as given by remote
).
This function is also useful if one wants to reset the timeout.
- Parameters:
-
remote the address we're about to connect to skip set to true if you want to skip this address
- Note:
- if the connection is successful, the connected signal will be emitted.
virtual bool KNetwork::KClientSocketBase::bind | ( | const TQString & | node = TQString::null , |
const TQString & | service = TQString::null |
||
) | [pure virtual] |
Binds this socket to the given nodename and service, or use the default ones if none are given.
Upon successful binding, the bound signal will be emitted. If an error is found, the gotError signal will be emitted.
- Note:
- Due to the internals of the name lookup and binding mechanism, some (if not most) implementations of this function do not actually bind the socket until the connection is requested (see connect). They only set the values for future reference.
This function returns true on success.
- Parameters:
-
node the nodename service the service
Implemented in KNetwork::KDatagramSocket, and KNetwork::KStreamSocket.
bool KClientSocketBase::bind | ( | const KResolverEntry & | address | ) | [virtual] |
Reimplemented from KSocketBase.
Connect this socket to this specific address.
Unlike bind(const TQString&, const TQString&) above, this function really does bind the socket. No lookup is performed. The bound signal will be emitted.
Reimplemented in KNetwork::KDatagramSocket, and KNetwork::KStreamSocket.
Definition at line 197 of file kclientsocketbase.cpp.
void KNetwork::KClientSocketBase::bound | ( | const KResolverEntry & | local | ) | [signal] |
This signal is emitted when the socket successfully binds to an address.
- Parameters:
-
local the local address we bound to
void KClientSocketBase::close | ( | ) | [virtual] |
Closes the socket.
Reimplemented from TQIODevice.
The closing of the socket causes the emission of the signal closed.
Reimplemented in KNetwork::KBufferedSocket.
Definition at line 269 of file kclientsocketbase.cpp.
void KNetwork::KClientSocketBase::closed | ( | ) | [signal] |
This signal is emitted when the socket completes the closing/shut down process.
virtual bool KNetwork::KClientSocketBase::connect | ( | const TQString & | node = TQString::null , |
const TQString & | service = TQString::null |
||
) | [pure virtual] |
Attempts to connect to the these hostname and service, or use the default ones if none are given.
If a connection attempt is already in progress, check on its state and set the error status (NoError or InProgress).
If the blocking mode for this object is on, this function will only return when all the resolved peer addresses have been tried or when a connection is established.
Upon successfully connecting, the connected signal will be emitted. If an error is found, the gotError signal will be emitted.
- Note for derived classes:
- Derived classes must implement this function. The implementation will set the parameters for the lookup (using the peer KResolver object) and call lookup to start it.
- The implementation should use the hostFound signal to be notified of the completion of the lookup process and then proceed to start the connection itself. Care should be taken regarding the value of blocking flag.
- Parameters:
-
node the nodename service the service
Implemented in KNetwork::KDatagramSocket, and KNetwork::KStreamSocket.
bool KClientSocketBase::connect | ( | const KResolverEntry & | address | ) | [virtual] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Reimplemented from KSocketBase.
Reimplemented in KNetwork::KDatagramSocket, and KNetwork::KStreamSocket.
Definition at line 218 of file kclientsocketbase.cpp.
void KNetwork::KClientSocketBase::connected | ( | const KResolverEntry & | remote | ) | [signal] |
This socket is emitted when the socket successfully connects to a remote address.
- Parameters:
-
remote the remote address we did connect to
void KNetwork::KClientSocketBase::connectToHost | ( | const TQString & | host, |
TQ_UINT16 | port | ||
) | [inline] |
- Deprecated:
- This is a convenience function provided to ease migrating from Qt 3.x's TQSocket class.
Definition at line 270 of file kclientsocketbase.h.
void KNetwork::KClientSocketBase::copyError | ( | ) | [protected] |
Convenience function to set this object's error code to match that of the socket device.
bool KClientSocketBase::disconnect | ( | ) | [virtual] |
Disconnects the socket.
Note that not all socket types can disconnect.
Definition at line 252 of file kclientsocketbase.cpp.
bool KNetwork::KClientSocketBase::emitsReadyRead | ( | ) | const |
Returns true if the readyRead signal is set to be emitted.
bool KNetwork::KClientSocketBase::emitsReadyWrite | ( | ) | const |
Returns true if the readyWrite signal is set to be emitted.
virtual void KNetwork::KClientSocketBase::enableRead | ( | bool | enable | ) | [virtual] |
Enables the emission of the readyRead signal.
By default, this signal is enabled.
- Parameters:
-
enable whether to enable the signal
Reimplemented in KNetwork::KBufferedSocket.
virtual void KNetwork::KClientSocketBase::enableWrite | ( | bool | enable | ) | [virtual] |
Enables the emission of the readyWrite signal.
By default, this signal is disabled.
- Parameters:
-
enable whether to enable the signal
Reimplemented in KNetwork::KBufferedSocket.
virtual void KNetwork::KClientSocketBase::flush | ( | ) | [inline, virtual] |
This call is not supported on sockets.
Reimplemented from TQIODevice.
Definition at line 298 of file kclientsocketbase.h.
void KNetwork::KClientSocketBase::gotError | ( | int | code | ) | [signal] |
This signal is emitted when this object finds an error.
The code
parameter contains the error code that can also be found by calling error.
void KNetwork::KClientSocketBase::hostFound | ( | ) | [signal] |
This signal is emitted when the lookup is successfully completed.
virtual KSocketAddress KNetwork::KClientSocketBase::localAddress | ( | ) | const [virtual] |
Returns the local socket address.
Reimplemented from KSocketBase.
KResolver & KClientSocketBase::localResolver | ( | ) | const |
Returns the internal KResolver object used for looking up the local host name and service.
This can be used to set extra options to the lookup process other than the default values, as well as obtaining the error codes in case of lookup failure.
Definition at line 109 of file kclientsocketbase.cpp.
const KResolverResults & KClientSocketBase::localResults | ( | ) | const |
Returns the internal list of resolved results for the local address.
Definition at line 114 of file kclientsocketbase.cpp.
bool KClientSocketBase::lookup | ( | ) | [virtual] |
Starts the lookup for peer and local hostnames as well as their services.
If the blocking mode for this object is on, this function will wait for the lookup results to be available (by calling the KResolver::wait method on the resolver objects).
When the lookup is done, the signal hostFound will be emitted (only once, even if we're doing a double lookup). If the lookup failed (for any of the two lookups) the gotError signal will be emitted with the appropriate error condition (see KSocketBase::SocketError).
This function returns true on success and false on error. Note that this is not the lookup result!
Definition at line 139 of file kclientsocketbase.cpp.
virtual bool KNetwork::KClientSocketBase::open | ( | TQ_OpenMode | ) | [inline, virtual] |
Opens the socket.
Reimplemented from TQIODevice.
You should not call this function; instead, use connect
Definition at line 284 of file kclientsocketbase.h.
virtual TQ_LONG KNetwork::KClientSocketBase::peekBlock | ( | char * | data, |
TQ_ULONG | maxlen | ||
) | [virtual] |
Peeks data from the socket.
Reimplemented from KSocketBase.
Reimplemented in KNetwork::KBufferedSocket.
virtual TQ_LONG KNetwork::KClientSocketBase::peekBlock | ( | char * | data, |
TQ_ULONG | maxlen, | ||
KSocketAddress & | from | ||
) | [virtual] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Peeks data from the socket.
Reimplemented from KSocketBase.
Reimplemented in KNetwork::KBufferedSocket.
virtual KSocketAddress KNetwork::KClientSocketBase::peerAddress | ( | ) | const [virtual] |
Returns the peer socket address.
Reimplemented from KSocketBase.
KResolver & KClientSocketBase::peerResolver | ( | ) | const |
Returns the internal KResolver object used for looking up the peer host name and service.
This can be used to set extra options to the lookup process other than the default values, as well as obtaining the error codes in case of lookup failure.
Definition at line 99 of file kclientsocketbase.cpp.
const KResolverResults & KClientSocketBase::peerResults | ( | ) | const |
Returns the internal list of resolved results for the peer address.
Definition at line 104 of file kclientsocketbase.cpp.
void KNetwork::KClientSocketBase::readyRead | ( | ) | [signal] |
This signal is emitted whenever the socket is ready for reading -- i.e., there is data to be read in the buffers.
The subsequent read operation is guaranteed to be non-blocking.
You can toggle the emission of this signal with the enableRead function. This signal is by default enabled.
void KNetwork::KClientSocketBase::readyWrite | ( | ) | [signal] |
This signal is emitted whenever the socket is ready for writing -- i.e., whenever there's space available in the buffers to receive more data.
The subsequent write operation is guaranteed to be non-blocking.
You can toggle the emission of this signal with the enableWrite function. This signal is by default disabled. You will want to disable this signal after the first reception, since it'll probably fire at every event loop.
void KClientSocketBase::setFamily | ( | int | families | ) |
Sets the allowed families for the resolutions.
- Parameters:
-
families the families that we want/accept
- See also:
- KResolver::SocketFamilies for possible values
Definition at line 133 of file kclientsocketbase.cpp.
void KClientSocketBase::setResolutionEnabled | ( | bool | enable | ) |
Enables or disables name resolution.
If this flag is set to true, bind and connect operations will trigger name lookup operations (i.e., converting a hostname into its binary form). If the flag is set to false, those operations will instead try to convert a string representation of an address without attempting name resolution.
This is useful, for instance, when IP addresses are in their string representation (such as "1.2.3.4") or come from other sources like KSocketAddress.
- Parameters:
-
enable whether to enable
Definition at line 119 of file kclientsocketbase.cpp.
bool KClientSocketBase::setSocketOptions | ( | int | opts | ) | [protected, virtual] |
Sets the socket options.
Reimplemented from KSocketBase.
Reimplemented in KNetwork::KBufferedSocket.
Definition at line 83 of file kclientsocketbase.cpp.
void KClientSocketBase::setState | ( | SocketState | state | ) | [protected] |
Sets the socket state to state
.
This function does not emit the stateChanged signal.
Definition at line 77 of file kclientsocketbase.cpp.
virtual void KNetwork::KClientSocketBase::slotReadActivity | ( | ) | [protected, virtual, slot] |
This slot is connected to the read notifier's signal meaning the socket can read more data.
The default implementation only emits the readyRead signal.
Override if your class requires processing of incoming data.
Reimplemented in KNetwork::KBufferedSocket.
virtual void KNetwork::KClientSocketBase::slotWriteActivity | ( | ) | [protected, virtual, slot] |
This slot is connected to the write notifier's signal meaning the socket can write more data.
The default implementation only emits the readyWrite signal.
Override if your class writes data from another source (like a buffer).
Reimplemented in KNetwork::KBufferedSocket.
Returns the current state for this socket.
- See also:
- SocketState
Definition at line 72 of file kclientsocketbase.cpp.
void KNetwork::KClientSocketBase::stateChanged | ( | int | newstate | ) | [signal] |
This signal is emitted whenever the socket state changes.
Note: do not delete this object inside the slot called by this signal.
- Parameters:
-
newstate the new state of the socket object
virtual void KNetwork::KClientSocketBase::stateChanging | ( | SocketState | newState | ) | [protected, virtual] |
This function is called by setState whenever the state changes.
You should override it if you need to specify any actions to be done when the state changes.
The default implementation acts for these states only:
- Connected: it sets up the socket notifiers to fire readyRead and readyWrite signals.
Reimplemented in KNetwork::KBufferedSocket.
virtual TQT_TQIO_LONG KNetwork::KClientSocketBase::tqreadBlock | ( | char * | data, |
TQT_TQIO_ULONG | maxlen | ||
) | [virtual] |
Reads data from a socket.
Reimplemented from KSocketBase.
Reimplemented in KNetwork::KBufferedSocket.
virtual TQT_TQIO_LONG KNetwork::KClientSocketBase::tqreadBlock | ( | char * | data, |
TQT_TQIO_ULONG | maxlen, | ||
KSocketAddress & | from | ||
) | [virtual] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Reads data from a socket.
Reimplemented from KSocketBase.
Reimplemented in KNetwork::KBufferedSocket.
virtual TQT_TQIO_LONG KNetwork::KClientSocketBase::tqwriteBlock | ( | const char * | data, |
TQT_TQIO_ULONG | len | ||
) | [virtual] |
Writes data to the socket.
Reimplemented from KSocketBase.
Reimplemented in KNetwork::KBufferedSocket.
virtual TQT_TQIO_LONG KNetwork::KClientSocketBase::tqwriteBlock | ( | const char * | data, |
TQT_TQIO_ULONG | len, | ||
const KSocketAddress & | to | ||
) | [virtual] |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Writes data to the socket.
Reimplemented from KSocketBase.
Reimplemented in KNetwork::KBufferedSocket.
virtual TQ_LONG KNetwork::KClientSocketBase::waitForMore | ( | int | msecs, |
bool * | timeout = 0L |
||
) | [virtual] |
Returns the number of bytes available on this socket.
Reimplemented from KSocketBase. Waits for more data. Reimplemented from KSocketBase.
Reimplemented in KNetwork::KBufferedSocket.
The documentation for this class was generated from the following files: