• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

  • KNetwork
  • KSocketDevice
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KNetwork::KSocketDevice Class Reference

#include <ksocketdevice.h>

Inheritance diagram for KNetwork::KSocketDevice:
KNetwork::KActiveSocketBase KNetwork::KPassiveSocketBase KNetwork::KSocketBase KNetwork::KSocketBase KNetwork::KHttpProxySocketDevice KNetwork::KMulticastSocketImpl KNetwork::KSocksSocketDevice

Public Types

enum  Capabilities {
  CanConnectString = 0x01 , CanBindString = 0x02 , CanNotBind = 0x04 , CanNotListen = 0x08 ,
  CanMulticast = 0x10 , CanNotUseDatagrams = 0x20
}
 
- Public Types inherited from KNetwork::KSocketBase
enum  SocketOptions {
  Blocking = 0x01 , AddressReuseable = 0x02 , IPv6Only = 0x04 , Keepalive = 0x08 ,
  Broadcast = 0x10
}
 
enum  SocketError {
  NoError = 0 , LookupFailure , AddressInUse , AlreadyCreated ,
  AlreadyBound , AlreadyConnected , NotConnected , NotBound ,
  NotCreated , WouldBlock , ConnectionRefused , ConnectionTimedOut ,
  InProgress , NetFailure , NotSupported , Timeout ,
  UnknownError , RemotelyDisconnected
}
 

Public Member Functions

 KSocketDevice (const KSocketBase *=0L)
 
 KSocketDevice (int fd)
 
virtual ~KSocketDevice ()
 
int socket () const
 
virtual int capabilities () const
 
virtual bool setSocketOptions (int opts)
 
virtual bool open (TQ_OpenMode mode)
 
virtual void close ()
 
virtual void flush ()
 
virtual bool create (int family, int type, int protocol)
 
bool create (const KResolverEntry &address)
 
virtual bool bind (const KResolverEntry &address)
 
virtual bool listen (int backlog=5)
 
virtual bool connect (const KResolverEntry &address)
 
virtual KSocketDevice * accept ()
 
virtual bool disconnect ()
 
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
 
virtual KSocketAddress externalAddress () const
 
TQSocketNotifier * readNotifier () const
 
TQSocketNotifier * writeNotifier () const
 
TQSocketNotifier * exceptionNotifier () const
 
virtual bool poll (bool *input, bool *output, bool *exception=0L, int timeout=-1, bool *timedout=0L)
 
bool poll (int timeout=-1, bool *timedout=0L)
 
- Public Member Functions inherited from KNetwork::KActiveSocketBase
 KActiveSocketBase ()
 
virtual ~KActiveSocketBase ()
 
virtual Offset size () const
 
virtual Offset at () const
 
virtual bool at (Offset)
 
virtual bool atEnd () const
 
virtual int getch ()
 
virtual int putch (int ch)
 
virtual int ungetch (int)
 
- Public Member Functions inherited from KNetwork::KSocketBase
 KSocketBase ()
 
virtual ~KSocketBase ()
 
virtual bool setBlocking (bool enable)
 
bool blocking () const
 
virtual bool setAddressReuseable (bool enable)
 
bool addressReuseable () const
 
virtual bool setIPv6Only (bool enable)
 
bool isIPv6Only () const
 
virtual bool setBroadcast (bool enable)
 
bool broadcast () const
 
KSocketDevice * socketDevice () const
 
virtual void setSocketDevice (KSocketDevice *device)
 
int setRequestedCapabilities (int add, int remove=0)
 
SocketError error () const
 
TQString errorString () const
 
TQMutex * mutex () const
 
- Public Member Functions inherited from KNetwork::KPassiveSocketBase
 KPassiveSocketBase ()
 
virtual ~KPassiveSocketBase ()
 

Static Public Member Functions

static KSocketDevice * createDefault (KSocketBase *parent)
 
static KSocketDevice * createDefault (KSocketBase *parent, int capabilities)
 
static KSocketDeviceFactoryBase * setDefaultImpl (KSocketDeviceFactoryBase *factory)
 
static void addNewImpl (KSocketDeviceFactoryBase *factory, int capabilities)
 
- Static Public Member Functions inherited from KNetwork::KSocketBase
static TQString errorString (SocketError code)
 
static bool isFatalError (int code)
 

Protected Member Functions

 KSocketDevice (bool, const KSocketBase *parent=0L)
 
virtual TQSocketNotifier * createNotifier (TQSocketNotifier::Type type) const
 
- Protected Member Functions inherited from KNetwork::KActiveSocketBase
void setError (int status, SocketError error)
 
void resetError ()
 
- Protected Member Functions inherited from KNetwork::KSocketBase
virtual int socketOptions () const
 
bool hasDevice () const
 
void setError (SocketError error)
 

Protected Attributes

int m_sockfd
 

Detailed Description

Low-level socket functionality.

This class provides low-level socket functionality.

Most users will prefer "cooked" interfaces like those of KStreamSocket or KServerSocket.

Descended classes from this one provide some other kinds of socket functionality, like proxying or specific socket types.

Author
Thiago Macieira thiag.nosp@m.o.ma.nosp@m.cieir.nosp@m.a@kd.nosp@m.email.nosp@m..net

Definition at line 50 of file ksocketdevice.h.

Member Enumeration Documentation

◆ Capabilities

enum KNetwork::KSocketDevice::Capabilities

Capabilities for the socket implementation.

KSocketDevice-derived classes can implement certain capabilities that are not available in the default class. These capabilities are described by these flags. The default KSocketDevice class has none of these capabilities.

For the negative capabilities (inabilities, the CanNot* forms), when a capability is not present, the implementation will default to the original behaviour.

Enumerator
CanConnectString 

Can connect to hostnames.

If this flag is present, the string form of connect can be used.

CanBindString 

Can bind to hostnames.

If this flag is present, the string form of bind can be used

CanNotBind 

Can not bind.

If this flag is present, this implementation cannot bind

CanNotListen 

Can not listen.

If this flag is present, this implementation cannot listen

CanMulticast 

Can send multicast as well as join/leave multicast groups.

CanNotUseDatagrams 

Can not use datagrams.

Note that this implies multicast capability not being available either.

Definition at line 63 of file ksocketdevice.h.

Constructor & Destructor Documentation

◆ KSocketDevice() [1/3]

KSocketDevice::KSocketDevice ( const KSocketBase *  parent = 0L)
explicit

Default constructor.

The parameter is used to specify which socket this object is used as a device for.

Definition at line 78 of file ksocketdevice.cpp.

◆ KSocketDevice() [2/3]

KSocketDevice::KSocketDevice ( int  fd)
explicit

Constructs a new object around an already-open socket.

Note: you should write programs that create sockets through the classes whenever possible.

Definition at line 86 of file ksocketdevice.cpp.

◆ ~KSocketDevice()

KSocketDevice::~KSocketDevice ( )
virtual

Destructor.

This closes the socket if it's open.

Definition at line 103 of file ksocketdevice.cpp.

◆ KSocketDevice() [3/3]

KSocketDevice::KSocketDevice ( bool  ,
const KSocketBase *  parent = 0L 
)
protected

Special constructor.

This constructor will cause the internal socket device NOT to be set. Use this if your socket device class takes another underlying socket device.

Parameters
parentthe parent, if any

Definition at line 95 of file ksocketdevice.cpp.

Member Function Documentation

◆ accept()

KSocketDevice * KSocketDevice::accept ( )
virtual

Accepts a new incoming connection.

Note: this function returns a socket of type KSocketDevice.

Implements KNetwork::KPassiveSocketBase.

Reimplemented in KNetwork::KSocksSocketDevice.

Definition at line 309 of file ksocketdevice.cpp.

◆ addNewImpl()

void KSocketDevice::addNewImpl ( KSocketDeviceFactoryBase *  factory,
int  capabilities 
)
static

Adds a factory of KSocketDevice objects to the list, along with its capabilities flag.

Definition at line 884 of file ksocketdevice.cpp.

◆ bind()

bool KSocketDevice::bind ( const KResolverEntry &  address)
virtual

Binds this socket to the given address.

Implements KNetwork::KActiveSocketBase.

Reimplemented in KNetwork::KSocksSocketDevice.

Definition at line 232 of file ksocketdevice.cpp.

◆ capabilities()

virtual int KNetwork::KSocketDevice::capabilities ( ) const
inlinevirtual

Returns the set of capabilities this socket class implements.

The set of capabilities is defined as an OR-ed mask of Capabilities bits.

The default implementation is guaranteed to always return 0. That is, derived implementations always return bits where they differ from the system standard sockets.

Reimplemented in KNetwork::KSocksSocketDevice, KNetwork::KMulticastSocketImpl, and KNetwork::KHttpProxySocketDevice.

Definition at line 134 of file ksocketdevice.h.

◆ close()

void KSocketDevice::close ( )
virtual

Closes the socket.

Reimplemented from TQIODevice.

Use this function to close the socket this object is holding open.

Implements KNetwork::KPassiveSocketBase.

Reimplemented in KNetwork::KHttpProxySocketDevice.

Definition at line 180 of file ksocketdevice.cpp.

◆ connect()

bool KSocketDevice::connect ( const KResolverEntry &  address)
virtual

Connect to a remote host.

Implements KNetwork::KActiveSocketBase.

Reimplemented in KNetwork::KSocksSocketDevice, KNetwork::KMulticastSocketImpl, and KNetwork::KHttpProxySocketDevice.

Definition at line 276 of file ksocketdevice.cpp.

◆ create() [1/2]

bool KSocketDevice::create ( const KResolverEntry &  address)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Creates a socket but don't connect or bind anywhere.

Definition at line 227 of file ksocketdevice.cpp.

◆ create() [2/2]

bool KSocketDevice::create ( int  family,
int  type,
int  protocol 
)
virtual

Creates a socket but don't connect or bind anywhere.

This function is the equivalent of the system call socket(2).

Reimplemented in KNetwork::KMulticastSocketImpl.

Definition at line 201 of file ksocketdevice.cpp.

◆ createDefault() [1/2]

KSocketDevice * KSocketDevice::createDefault ( KSocketBase *  parent)
static

Creates a new default KSocketDevice object given the parent object.

The capabilities flag indicates the desired capabilities the object being created should possess. Those capabilities are not guaranteed: if no factory can provide such an object, a default object will be created.

Parameters
parentthe KSocketBase parent

Definition at line 844 of file ksocketdevice.cpp.

◆ createDefault() [2/2]

KSocketDevice * KSocketDevice::createDefault ( KSocketBase *  parent,
int  capabilities 
)
static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This will create an object only if the requested capabilities match.

Parameters
parentthe parent
capabilitiesthe requested capabilities

Definition at line 859 of file ksocketdevice.cpp.

◆ createNotifier()

TQSocketNotifier * KSocketDevice::createNotifier ( TQSocketNotifier::Type  type) const
protectedvirtual

Creates a socket notifier of the given type.

This function is called by readNotifier, writeNotifier and exceptionNotifier when they need to create a socket notifier (i.e., the first call to those functions after the socket is open). After that call, those functions cache the socket notifier and will not need to call this function again.

Reimplement this function in your derived class if your socket type requires a different kind of TQSocketNotifier. The return value should be deleteable with delete. (close deletes them).

Parameters
typethe socket notifier type

Definition at line 796 of file ksocketdevice.cpp.

◆ disconnect()

bool KSocketDevice::disconnect ( )
virtual

Disconnects this socket.

Implements KNetwork::KActiveSocketBase.

Definition at line 333 of file ksocketdevice.cpp.

◆ exceptionNotifier()

TQSocketNotifier * KSocketDevice::exceptionNotifier ( ) const

Returns a socket notifier for exceptional events on this socket.

The is created only when requested.

This function might return NULL.

Definition at line 650 of file ksocketdevice.cpp.

◆ externalAddress()

KSocketAddress KSocketDevice::externalAddress ( ) const
virtual

Returns this socket's externally visible local address.

If this socket has a local address visible externally different from the normal local address (as returned by localAddress), then return it.

Certain implementations will use proxies and thus have externally visible addresses different from the local socket values. The default implementation returns the same value as localAddress.

Note
This function may return an empty KSocketAddress. In that case, the externally visible address could/can not be determined.

Implements KNetwork::KPassiveSocketBase.

Reimplemented in KNetwork::KSocksSocketDevice, and KNetwork::KHttpProxySocketDevice.

Definition at line 607 of file ksocketdevice.cpp.

◆ flush()

virtual void KNetwork::KSocketDevice::flush ( )
inlinevirtual

This call is not supported on sockets.

Reimplemented from TQIODevice.

Definition at line 157 of file ksocketdevice.h.

◆ listen()

bool KSocketDevice::listen ( int  backlog = 5)
virtual

Puts this socket into listening mode.

Implements KNetwork::KPassiveSocketBase.

Reimplemented in KNetwork::KSocksSocketDevice.

Definition at line 255 of file ksocketdevice.cpp.

◆ localAddress()

KSocketAddress KSocketDevice::localAddress ( ) const
virtual

Returns this socket's local address.

Implements KNetwork::KActiveSocketBase.

Reimplemented in KNetwork::KSocksSocketDevice.

Definition at line 535 of file ksocketdevice.cpp.

◆ open()

bool KSocketDevice::open ( TQ_OpenMode  mode)
virtual

Reimplementation from TQIODevice.

You should not call this function in sockets.

Definition at line 174 of file ksocketdevice.cpp.

◆ peekBlock() [1/2]

TQ_LONG KSocketDevice::peekBlock ( char *  data,
TQ_ULONG  maxlen 
)
virtual

Peeks data in the socket.

Implements KNetwork::KActiveSocketBase.

Reimplemented in KNetwork::KSocksSocketDevice.

Definition at line 464 of file ksocketdevice.cpp.

◆ peekBlock() [2/2]

TQ_LONG KSocketDevice::peekBlock ( char *  data,
TQ_ULONG  maxlen,
KSocketAddress &  from 
)
virtual

Peeks the data in the socket and the source address.

Implements KNetwork::KActiveSocketBase.

Reimplemented in KNetwork::KSocksSocketDevice.

Definition at line 485 of file ksocketdevice.cpp.

◆ peerAddress()

KSocketAddress KSocketDevice::peerAddress ( ) const
virtual

Returns this socket's peer address.

If this implementation does proxying of some sort, this is the real external address, not the proxy's address.

Implements KNetwork::KActiveSocketBase.

Reimplemented in KNetwork::KSocksSocketDevice, and KNetwork::KHttpProxySocketDevice.

Definition at line 571 of file ksocketdevice.cpp.

◆ poll() [1/2]

bool KSocketDevice::poll ( bool *  input,
bool *  output,
bool *  exception = 0L,
int  timeout = -1,
bool *  timedout = 0L 
)
virtual

Executes a poll in the socket, via select(2) or poll(2).

The events polled are returned in the parameters pointers. Set any of them to NULL to disable polling of that event.

On exit, input, output and exception will contain true if an event of that kind is waiting on the socket or false if not. If a timeout occurred, set timedout to true (all other parameters are necessarily set to false).

Parameters
inputif set, turns on polling for input events
outputif set, turns on polling for output events
exceptionif set, turns on polling for exceptional events
timeoutthe time in milliseconds to wait for an event; 0 for no wait and any negative value to wait forever
timedouton exit, will contain true if the polling timed out
Returns
true if the poll call succeeded and false if an error occurred

Reimplemented in KNetwork::KSocksSocketDevice.

Definition at line 668 of file ksocketdevice.cpp.

◆ poll() [2/2]

bool KSocketDevice::poll ( int  timeout = -1,
bool *  timedout = 0L 
)

Shorter version to poll for any events in a socket.

This call polls for input, output and exceptional events in a socket but does not return their states. This is useful if you need to wait for any event, but don't need to know which; or for timeouts.

Parameters
timeoutthe time in milliseconds to wait for an event; 0 for no wait and any negative value to wait forever
timedouton exit, will contain true if the polling timed out
Returns
true if the poll call succeeded and false if an error occurred

Definition at line 790 of file ksocketdevice.cpp.

◆ readNotifier()

TQSocketNotifier * KSocketDevice::readNotifier ( ) const

Returns a socket notifier for input on this socket.

The notifier is created only when requested. Whether it is enabled or not depends on the implementation.

This function might return NULL.

Definition at line 614 of file ksocketdevice.cpp.

◆ setDefaultImpl()

KSocketDeviceFactoryBase * KSocketDevice::setDefaultImpl ( KSocketDeviceFactoryBase *  factory)
static

Sets the default KSocketDevice implementation to use and return the old factory.

Parameters
factorythe factory object for the implementation

Definition at line 876 of file ksocketdevice.cpp.

◆ setSocketOptions()

bool KSocketDevice::setSocketOptions ( int  opts)
virtual

This implementation sets the options on the socket.

Reimplemented from KNetwork::KSocketBase.

Definition at line 110 of file ksocketdevice.cpp.

◆ socket()

int KNetwork::KSocketDevice::socket ( ) const
inline

Returns the file descriptor for this socket.

Definition at line 122 of file ksocketdevice.h.

◆ tqreadBlock() [1/2]

TQT_TQIO_LONG KSocketDevice::tqreadBlock ( char *  data,
TQT_TQIO_ULONG  maxlen 
)
virtual

Reads data from this socket.

Implements KNetwork::KActiveSocketBase.

Definition at line 422 of file ksocketdevice.cpp.

◆ tqreadBlock() [2/2]

TQT_TQIO_LONG KSocketDevice::tqreadBlock ( char *  data,
TQT_TQIO_ULONG  maxlen,
KSocketAddress &  from 
)
virtual

Reads data and the source address from this socket.

Implements KNetwork::KActiveSocketBase.

Definition at line 443 of file ksocketdevice.cpp.

◆ tqwriteBlock() [1/2]

TQT_TQIO_LONG KSocketDevice::tqwriteBlock ( const char *  data,
TQT_TQIO_ULONG  len 
)
virtual

Writes data to the socket.

Implements KNetwork::KActiveSocketBase.

Definition at line 506 of file ksocketdevice.cpp.

◆ tqwriteBlock() [2/2]

TQT_TQIO_LONG KSocketDevice::tqwriteBlock ( const char *  data,
TQT_TQIO_ULONG  len,
const KSocketAddress &  to 
)
virtual

Writes the given data to the given destination address.

Implements KNetwork::KActiveSocketBase.

Definition at line 511 of file ksocketdevice.cpp.

◆ waitForMore()

TQ_LONG KSocketDevice::waitForMore ( int  msecs,
bool *  timeout = 0L 
)
virtual

Returns the number of bytes available for reading without blocking.

Waits up to msecs for more data to be available on this socket.

This function is a wrapper against poll. This function will wait for any read events.

Implements KNetwork::KActiveSocketBase.

Definition at line 384 of file ksocketdevice.cpp.

◆ writeNotifier()

TQSocketNotifier * KSocketDevice::writeNotifier ( ) const

Returns a socket notifier for output on this socket.

The is created only when requested.

This function might return NULL.

Definition at line 632 of file ksocketdevice.cpp.

Member Data Documentation

◆ m_sockfd

int KNetwork::KSocketDevice::m_sockfd
protected

The socket file descriptor.

It is used throughout the implementation and subclasses.

Definition at line 95 of file ksocketdevice.h.


The documentation for this class was generated from the following files:
  • ksocketdevice.h
  • ksocketdevice.cpp

kdecore

Skip menu "kdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.9.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |