Client-side implementation of connection-based socket. More...
#include <CeylanClientStreamSocket.h>
Classes | |
class | ClientStreamSocketException |
Mother class for all stream socket-related exceptions, on the client side. More... | |
Public Types | |
enum | TextOutputFormat { rawText, html } |
Defines what text output formats for TextDisplayable instances are available. More... | |
Public Member Functions | |
ClientStreamSocket () | |
Constructs a client-side stream socket. | |
virtual | ~ClientStreamSocket () throw () |
Virtual destructor. | |
virtual bool | isConnected () const |
Tells whether this socket is currenty connnected to a server. | |
virtual void | connect (const std::string &serverHostname, Port serverPort) |
Connects this socket to the specified server. | |
virtual void | disconnect () |
Disconnects this socket so that it will be able to connect to servers again in the future. | |
virtual Port | getPeerPort () const |
Returns the remote port number this socket is linked to, i.e. | |
virtual const std::string | toString (Ceylan::VerbosityLevels level=Ceylan::high) const |
Returns a user-friendly description of the state of this object. | |
virtual void | setBlocking (bool newStatus) |
Sets the blocking mode of this stream socket. | |
virtual bool | hasAvailableData () const |
Tells whether there is data available on input, i.e. | |
virtual System::Size | read (char *buffer, System::Size maxLength) |
Reads up to maxLength bytes from this socket to specified buffer. | |
virtual System::Size | write (const std::string &message) |
Writes message to this socket. | |
virtual System::Size | write (const char *buffer, System::Size maxLength) |
Writes up to maxLength bytes from the specified buffer to this socket. | |
System::FileDescriptor | getOriginalFileDescriptor () const |
Returns the original file descriptor associated with the socket on its creation. | |
virtual System::FileDescriptor | getFileDescriptorForTransport () const |
Returns the file descriptor that should be used for that socket to communicate with its peer(s). | |
virtual Port | getLocalPort () const |
Returns the local port number of the socket. | |
virtual IPAddress * | getLocalIPAddress () const |
Returns the local IP address corresponding to this socket. | |
virtual IPAddress * | getPeerIPAddress () const |
Returns the remote IP address this socket is linked to, i.e. | |
virtual System::StreamID | getInputStreamID () const |
Returns the file descriptor for this socket, which is a StreamID. | |
virtual System::StreamID | getOutputStreamID () const |
Returns the file descriptor for this socket, which is a StreamID. | |
bool | isSelected () const |
Tells if the stream has data to read. | |
bool | isFaulty () const |
virtual void | clearInput () |
Clears the input stream. | |
virtual Ceylan::Sint8 | readSint8 () |
Returns a Ceylan::Sint8 read from this input stream. | |
virtual Ceylan::Uint8 | readUint8 () |
Returns a Ceylan::Uint8 read from this input stream. | |
virtual Ceylan::Sint16 | readSint16 () |
Returns a Ceylan::Sint16 read from this input stream. | |
virtual Ceylan::Uint16 | readUint16 () |
Returns a Ceylan::Uint16 read from this input stream. | |
virtual Ceylan::Sint32 | readSint32 () |
Returns a Ceylan::Sint32 read from this input stream. | |
virtual Ceylan::Uint32 | readUint32 () |
Returns a Ceylan::Uint32 read from this input stream. | |
virtual Ceylan::Float32 | readFloat32 () |
Returns a Ceylan::Float32 read from this input stream. | |
virtual Ceylan::Float64 | readFloat64 () |
Returns a Ceylan::Float64 read from this input stream. | |
virtual void | readString (std::string &result) |
Reads a string from this input stream, and stores it in the specified string. | |
virtual void | skipWhitespaces (Ceylan::Uint8 &firstNonSpace) |
Reads from this input stream as long as there are whitespaces to be read. | |
bool | isBlocking () const |
Tells whether this stream is in blocking mode (if true), or in non-blocking mode (if false). | |
virtual void | writeSint8 (Ceylan::Sint8 toWrite) |
Writes a Ceylan::Sint8 to this output stream. | |
virtual void | writeUint8 (Ceylan::Uint8 toWrite) |
Writes a Ceylan::Uint8 to this output stream. | |
virtual void | writeSint16 (Ceylan::Sint16 toWrite) |
Writes a Ceylan::Sint16 to this output stream. | |
virtual void | writeUint16 (Ceylan::Uint16 toWrite) |
Writes a Ceylan::Uint16 to this output stream. | |
virtual void | writeSint32 (Ceylan::Sint32 toWrite) |
Writes a Ceylan::Sint32 to this output stream. | |
virtual void | writeUint32 (Ceylan::Uint32 toWrite) |
Writes a Ceylan::Uint32 to this output stream. | |
virtual void | writeFloat32 (Ceylan::Float32 toWrite) |
Writes a Ceylan::Uint32 to this output stream. | |
virtual void | writeFloat64 (Ceylan::Float64 toWrite) |
Writes a Ceylan::Uint32 to this output stream. | |
virtual void | writeString (const std::string &toWrite) |
Writes a string to this output stream. | |
Static Public Member Functions | |
static Ceylan::Uint16 | Select (std::list< InputStream * > &is) |
Blocks the calling thread until bytes become available on one or more streams in is. | |
static Ceylan::Uint16 | Test (std::list< InputStream * > &is) |
Checks whether bytes become available on one or more streams in is. | |
static bool | Close (FileDescriptor &fd) |
Closes and zeroes the specified file descriptor. | |
static const std::string | ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high) |
Returns a user-friendly description of this list of pointers to text displayable instances. | |
static TextOutputFormat | GetOutputFormat () |
Returns the current overall text format to be used by TextDisplayable instances. | |
static void | SetOutputFormat (TextOutputFormat newOutputFormat) |
Sets the current overall text format to be used by TextDisplayable instances. | |
Protected Member Functions | |
virtual void | connected () |
Called, after the connection is established, by connect(). | |
const std::string & | getServerName () const |
Returns the hostname of the server. | |
virtual void | createSocket (Port port) |
Creates the stream (TCP) socket associated with the port port. | |
virtual void | setNagleAlgorithmTo (bool activated) |
Enables or disables the Nagle algorithm for this socket. | |
virtual bool | close () |
Closes the socket. | |
virtual void | setSelected (bool newStatus) |
Used to set the selection status of this stream. | |
void | setFaulty (bool newFaultyState=true) |
Sets the faulty state of this stream. | |
virtual void | setStreamID (StreamID newInputStreamID) |
Sets this input stream's unique ID. | |
Protected Attributes | |
bool | _nagleAlgorithmDeactivated |
Tells whether the Nagle algorithm is requested to be deactivated, so that the snappiest possible response (packet timing) is searched for (if true), even though it would be obtained at the expense of usable network bandwidth. | |
Port | _port |
The port this socket is created with. | |
SystemSpecificSocketAddress * | _address |
The system-specific socket address for this socket. | |
System::FileDescriptor | _originalFD |
Internal file descriptor, used if this feature is available. | |
bool | _isBlocking |
Stores whether the stream is in blocking mode. | |
Static Protected Attributes | |
static TextOutputFormat | _OutputFormat = rawText |
The text format to be used currently by TextDisplayable instances. | |
Private Member Functions | |
ClientStreamSocket (const ClientStreamSocket &source) | |
Copy constructor made private to ensure that it will be never called. | |
ClientStreamSocket & | operator= (const ClientStreamSocket &source) |
Assignment operator made private to ensure that it will be never called. | |
Private Attributes | |
std::string | _serverHostName |
The hostname of the server this socket is to be linked to. | |
HostDNSEntry * | _serverHostInfo |
DNS record for linked server. |
Client-side implementation of connection-based socket.
At any time, a client stream socket can be connected at most at one server.
These client sockets do not care about the nature of their servers, which can be indifferently sequential or multiplexed.
Definition at line 64 of file CeylanClientStreamSocket.h.
enum Ceylan::TextDisplayable::TextOutputFormat [inherited] |
Defines what text output formats for TextDisplayable instances are available.
Definition at line 124 of file CeylanTextDisplayable.h.
ClientStreamSocket::ClientStreamSocket | ( | ) |
Constructs a client-side stream socket.
SocketException | if socket creation failed. |
Definition at line 96 of file CeylanClientStreamSocket.cc.
ClientStreamSocket::~ClientStreamSocket | ( | ) | throw () [virtual] |
Virtual destructor.
Definition at line 115 of file CeylanClientStreamSocket.cc.
References _serverHostInfo.
Ceylan::Network::ClientStreamSocket::ClientStreamSocket | ( | const ClientStreamSocket & | source | ) | [private] |
Copy constructor made private to ensure that it will be never called.
The compiler should complain whenever this undefined constructor is called, implicitly or not.
void InputStream::clearInput | ( | ) | [virtual, inherited] |
Clears the input stream.
InputStream::ReadFailedException | if the operation failed. |
Reimplemented in Ceylan::System::Pipe.
Definition at line 179 of file CeylanInputStream.cc.
References dataUtils::b, Ceylan::System::InputStream::hasAvailableData(), and Ceylan::System::InputStream::read().
bool Stream::Close | ( | FileDescriptor & | fd | ) | [static, inherited] |
Closes and zeroes the specified file descriptor.
It is passed by address so that this function can set it to zero on successful close.
CloseException | if the close operation failed. |
Definition at line 114 of file CeylanStream.cc.
References Ceylan::System::Stream::close(), generalUtils::false, Ceylan::toString(), and generalUtils::true.
Referenced by Ceylan::System::StandardFile::close(), Ceylan::Network::Socket::close(), Ceylan::System::Pipe::close(), and Ceylan::System::LibfatFile::close().
bool Socket::close | ( | ) | [protected, virtual, inherited] |
Closes the socket.
CloseException | if the close operation failed. |
Implements Ceylan::System::Stream.
Definition at line 553 of file CeylanSocket.cc.
References Ceylan::Network::Socket::_originalFD, Ceylan::System::Stream::Close(), Ceylan::Network::explainSocketError(), generalUtils::false, and generalUtils::true.
Referenced by disconnect(), and Ceylan::Network::Socket::~Socket().
void ClientStreamSocket::connect | ( | const std::string & | serverHostname, | |
Port | serverPort | |||
) | [virtual] |
Connects this socket to the specified server.
Once the connection succeeds, the connected() method is automatically called.
Then when this method returns, the disconnect() method is called.
serverHostname | the hostname of the server. | |
serverPort | the TCP port of the server. |
SocketException | if the operation failed. If no server is available at the target endpoint, this method will fail with a SocketException carrying the message "Connection refused", ex: "could not connect to IP 127.0.0.1 for host 'localhost': Connection refused". The same error will occur if there is a server at the endpoint but its queue of pending connections is full. |
Definition at line 136 of file CeylanClientStreamSocket.cc.
References Ceylan::Network::Socket::_address, Ceylan::Network::StreamSocket::_nagleAlgorithmDeactivated, _serverHostInfo, _serverHostName, connected(), Ceylan::Network::StreamSocket::createSocket(), disconnect(), dataUtils::e, Ceylan::System::explainError(), Ceylan::Network::HostDNSEntry::getAddresses(), Ceylan::Network::Socket::getOriginalFileDescriptor(), isConnected(), Ceylan::Network::StreamSocket::setNagleAlgorithmTo(), toString(), Ceylan::toString(), Ceylan::Network::IPAddressvFour::toString(), and Ceylan::Exception::toString().
void ClientStreamSocket::connected | ( | ) | [protected, virtual] |
Called, after the connection is established, by connect().
In connect(), just after this connected() method returns, the disconnect() method is automatically called.
ClientStreamSocketException | on failure. |
Definition at line 300 of file CeylanClientStreamSocket.cc.
Referenced by connect().
void StreamSocket::createSocket | ( | Port | port | ) | [protected, virtual, inherited] |
Creates the stream (TCP) socket associated with the port port.
SocketException | if the operation failed. |
Implements Ceylan::Network::Socket.
Definition at line 201 of file CeylanStreamSocket.cc.
References Ceylan::Network::Socket::_address, Ceylan::Network::Socket::_originalFD, Ceylan::Network::Socket::_port, dataUtils::e, Ceylan::System::explainError(), Ceylan::Network::explainSocketError(), Ceylan::System::Stream::isBlocking(), Ceylan::Network::StreamSocket::setBlocking(), Ceylan::Exception::toString(), and Ceylan::toString().
Referenced by connect(), and Ceylan::Network::StreamSocket::StreamSocket().
void ClientStreamSocket::disconnect | ( | ) | [virtual] |
Disconnects this socket so that it will be able to connect to servers again in the future.
SocketException | if the socket is not already connected. |
Definition at line 240 of file CeylanClientStreamSocket.cc.
References _serverHostInfo, Ceylan::Network::Socket::close(), dataUtils::e, isConnected(), and Ceylan::Exception::toString().
Referenced by connect().
FileDescriptor Socket::getFileDescriptorForTransport | ( | ) | const [virtual, inherited] |
Returns the file descriptor that should be used for that socket to communicate with its peer(s).
SocketException | if the operation failed, or FeatureNotAvailableException if the file descriptor feature is not available. |
Reimplemented in Ceylan::Network::SequentialServerStreamSocket.
Definition at line 389 of file CeylanSocket.cc.
References Ceylan::Network::Socket::_originalFD.
Referenced by Ceylan::Network::Socket::getInputStreamID(), Ceylan::Network::Socket::getOutputStreamID(), Ceylan::Network::Socket::hasAvailableData(), Ceylan::Network::StreamSocket::setNagleAlgorithmTo(), Ceylan::Network::Socket::toString(), and Ceylan::Network::Socket::write().
StreamID Socket::getInputStreamID | ( | ) | const [virtual, inherited] |
Returns the file descriptor for this socket, which is a StreamID.
InputStreamException | if no identifier is available, or if the file descriptor feature is not available. |
Implements Ceylan::System::InputStream.
Definition at line 446 of file CeylanSocket.cc.
References Ceylan::Network::Socket::getFileDescriptorForTransport(), and Ceylan::Exception::toString().
IPAddress * Socket::getLocalIPAddress | ( | ) | const [virtual, inherited] |
Returns the local IP address corresponding to this socket.
Ownership of the returned object is transferred to the caller, which has to deallocate it when of no more use.
SocketException | if this operation failed. |
Definition at line 426 of file CeylanSocket.cc.
Port Socket::getLocalPort | ( | ) | const [virtual, inherited] |
Returns the local port number of the socket.
SocketException | if this operation failed. |
Reimplemented in Ceylan::Network::ServerStreamSocket.
Definition at line 408 of file CeylanSocket.cc.
Referenced by Ceylan::Network::Socket::toString().
FileDescriptor Socket::getOriginalFileDescriptor | ( | ) | const [inherited] |
Returns the original file descriptor associated with the socket on its creation.
This file descriptor does not change, both for client and server sides.
SocketException | if the operation failed, or FeatureNotAvailableException if the file descriptor feature is not available. |
Definition at line 371 of file CeylanSocket.cc.
References Ceylan::Network::Socket::_originalFD.
Referenced by Ceylan::Network::SequentialServerStreamSocket::accept(), Ceylan::Network::MultiplexedServerStreamSocket::accept(), Ceylan::Network::MultiplexedProtocolBasedStreamServer::accept(), connect(), Ceylan::Network::SequentialServerStreamSocket::getFileDescriptorForTransport(), Ceylan::Network::ServerStreamSocket::prepareToAccept(), Ceylan::Network::MultiplexedServerStreamSocket::run(), Ceylan::Network::ServerStreamSocket::ServerStreamSocket(), Ceylan::Network::StreamSocket::setBlocking(), and Ceylan::Network::Socket::toString().
TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat | ( | ) | [static, inherited] |
Returns the current overall text format to be used by TextDisplayable instances.
Definition at line 63 of file CeylanTextDisplayable.cc.
References Ceylan::TextDisplayable::_OutputFormat.
Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().
StreamID Socket::getOutputStreamID | ( | ) | const [virtual, inherited] |
Returns the file descriptor for this socket, which is a StreamID.
OutputStreamException | if no identifier is available, or if the file descriptor feature is not available. |
Implements Ceylan::System::OutputStream.
Definition at line 473 of file CeylanSocket.cc.
References Ceylan::Network::Socket::getFileDescriptorForTransport(), and Ceylan::Exception::toString().
IPAddress * Socket::getPeerIPAddress | ( | ) | const [virtual, inherited] |
Returns the remote IP address this socket is linked to, i.e.
the IP address of the peer of this socket.
SocketException | if this operation failed, including if this socket is not connected. |
Definition at line 436 of file CeylanSocket.cc.
Port ClientStreamSocket::getPeerPort | ( | ) | const [virtual] |
Returns the remote port number this socket is linked to, i.e.
the port of the peer of this socket.
SocketException | if this operation failed, including if this socket is not connected. |
Reimplemented from Ceylan::Network::Socket.
Definition at line 271 of file CeylanClientStreamSocket.cc.
References Ceylan::Network::Socket::_port.
Referenced by toString().
const std::string & ClientStreamSocket::getServerName | ( | ) | const [protected] |
Returns the hostname of the server.
Definition at line 313 of file CeylanClientStreamSocket.cc.
References _serverHostName.
bool Socket::hasAvailableData | ( | ) | const [virtual, inherited] |
Tells whether there is data available on input, i.e.
on the file descriptor used for transport.
Implements Ceylan::System::InputStream.
Definition at line 226 of file CeylanSocket.cc.
References dataUtils::e, generalUtils::false, Ceylan::Network::Socket::getFileDescriptorForTransport(), Ceylan::System::HasAvailableData(), and Ceylan::Exception::toString().
bool Stream::isBlocking | ( | ) | const [inherited] |
Tells whether this stream is in blocking mode (if true), or in non-blocking mode (if false).
Definition at line 93 of file CeylanStream.cc.
References Ceylan::System::Stream::_isBlocking.
Referenced by Ceylan::Network::StreamSocket::createSocket(), and Ceylan::Network::Socket::toString().
bool ClientStreamSocket::isConnected | ( | ) | const [virtual] |
Tells whether this socket is currenty connnected to a server.
Implements Ceylan::Network::Socket.
Definition at line 127 of file CeylanClientStreamSocket.cc.
References _serverHostInfo.
Referenced by connect(), disconnect(), and toString().
bool InputStream::isFaulty | ( | ) | const [inherited] |
Definition at line 131 of file CeylanInputStream.cc.
References Ceylan::System::InputStream::_isFaulty.
Referenced by Ceylan::System::InputStream::toString().
bool InputStream::isSelected | ( | ) | const [inherited] |
Tells if the stream has data to read.
Definition at line 122 of file CeylanInputStream.cc.
References Ceylan::System::InputStream::_isSelected.
Referenced by Ceylan::System::InputStream::toString().
ClientStreamSocket& Ceylan::Network::ClientStreamSocket::operator= | ( | const ClientStreamSocket & | source | ) | [private] |
Assignment operator made private to ensure that it will be never called.
The compiler should complain whenever this undefined operator is called, implicitly or not.
virtual System::Size Ceylan::Network::Socket::read | ( | char * | buffer, | |
System::Size | maxLength | |||
) | [virtual, inherited] |
Reads up to maxLength bytes from this socket to specified buffer.
buffer | the buffer where to store read bytes. Its size must be at least maxLength bytes. | |
maxLength | the maximum number of bytes that should be read. |
ReadFailedException | if a read error occurred. |
Reimplemented from Ceylan::System::InputStream.
Ceylan::Float32 InputStream::readFloat32 | ( | ) | [virtual, inherited] |
Returns a Ceylan::Float32 read from this input stream.
ReadFailedException | in case a system error occured, or EOFException is a protocol error occured, with fewer bytes available than expected. |
Definition at line 356 of file CeylanInputStream.cc.
References ceylan_bswap_32, and Ceylan::System::InputStream::read().
Referenced by Ceylan::Middleware::LightWeightMarshaller::decodeFloat32().
Ceylan::Float64 InputStream::readFloat64 | ( | ) | [virtual, inherited] |
Returns a Ceylan::Float64 read from this input stream.
ReadFailedException | in case a system error occured, or EOFException is a protocol error occured, with fewer bytes available than expected. |
Definition at line 392 of file CeylanInputStream.cc.
References Ceylan::byteswap(), ceylan_bswap_64, and Ceylan::System::InputStream::read().
Referenced by Ceylan::Middleware::LightWeightMarshaller::decodeFloat64().
Ceylan::Sint16 InputStream::readSint16 | ( | ) | [virtual, inherited] |
Returns a Ceylan::Sint16 read from this input stream.
ReadFailedException | in case a system error occured, or EOFException is a protocol error occured, with fewer bytes available than expected. |
Definition at line 239 of file CeylanInputStream.cc.
References ceylan_bswap_16, and Ceylan::System::InputStream::read().
Referenced by Ceylan::Middleware::LightWeightMarshaller::decodeSint16().
Ceylan::Sint32 InputStream::readSint32 | ( | ) | [virtual, inherited] |
Returns a Ceylan::Sint32 read from this input stream.
ReadFailedException | in case a system error occured, or EOFException is a protocol error occured, with fewer bytes available than expected. |
Definition at line 298 of file CeylanInputStream.cc.
References ceylan_bswap_32, and Ceylan::System::InputStream::read().
Referenced by Ceylan::Middleware::LightWeightMarshaller::decodeSint32().
Ceylan::Sint8 InputStream::readSint8 | ( | ) | [virtual, inherited] |
Returns a Ceylan::Sint8 read from this input stream.
ReadFailedException | in case a system error occured, or EOFException is a protocol error occured, with fewer bytes available than expected. |
Definition at line 203 of file CeylanInputStream.cc.
References Ceylan::System::InputStream::read().
Referenced by Ceylan::Middleware::LightWeightMarshaller::decodeSint8().
void InputStream::readString | ( | std::string & | result | ) | [virtual, inherited] |
Reads a string from this input stream, and stores it in the specified string.
result | the string to fill from this input stream. |
ReadFailedException | in case a system error occured, or EOFException is a protocol error occured, with fewer bytes available than expected. |
Definition at line 437 of file CeylanInputStream.cc.
References Ceylan::System::InputStream::read(), Ceylan::System::InputStream::readUint16(), and Ceylan::toString().
Referenced by Ceylan::Middleware::LightWeightMarshaller::decodeString().
Ceylan::Uint16 InputStream::readUint16 | ( | ) | [virtual, inherited] |
Returns a Ceylan::Uint16 read from this input stream.
ReadFailedException | in case a system error occured, or EOFException is a protocol error occured, with fewer bytes available than expected. |
Definition at line 268 of file CeylanInputStream.cc.
References ceylan_bswap_16, and Ceylan::System::InputStream::read().
Referenced by Ceylan::Middleware::LightWeightMarshaller::decodeUint16(), and Ceylan::System::InputStream::readString().
Ceylan::Uint32 InputStream::readUint32 | ( | ) | [virtual, inherited] |
Returns a Ceylan::Uint32 read from this input stream.
ReadFailedException | in case a system error occured, or EOFException is a protocol error occured, with fewer bytes available than expected. |
Definition at line 327 of file CeylanInputStream.cc.
References ceylan_bswap_32, and Ceylan::System::InputStream::read().
Referenced by Ceylan::Middleware::LightWeightMarshaller::decodeUint32().
Ceylan::Uint8 InputStream::readUint8 | ( | ) | [virtual, inherited] |
Returns a Ceylan::Uint8 read from this input stream.
ReadFailedException | in case a system error occured, or EOFException is a protocol error occured, with fewer bytes available than expected. |
Definition at line 221 of file CeylanInputStream.cc.
References Ceylan::System::InputStream::read().
Referenced by Ceylan::Middleware::LightWeightMarshaller::decodeUint8(), Ceylan::System::FileSystemManager::diff(), Ceylan::XML::XMLParser::handleNextElement(), Ceylan::XML::XMLParser::InterpretLowerThanSequence(), Ceylan::XML::XMLParser::InterpretXMLDeclaration(), and Ceylan::System::InputStream::skipWhitespaces().
Ceylan::Uint16 InputStream::Select | ( | std::list< InputStream * > & | is | ) | [static, inherited] |
Blocks the calling thread until bytes become available on one or more streams in is.
To see which are selected, use the isSelected
method.
SelectFailedException | if the operation failed, for example if the file descriptor feature is not available on this platform. |
Definition at line 534 of file CeylanInputStream.cc.
References Ceylan::System::explainError(), Ceylan::Network::explainSocketError(), Ceylan::System::getError(), Ceylan::Network::getSocketError(), Ceylan::System::Thread::Sleep(), and Ceylan::toString().
Referenced by Ceylan::Network::MultiplexedServerStreamSocket::run().
void StreamSocket::setBlocking | ( | bool | newStatus | ) | [virtual, inherited] |
Sets the blocking mode of this stream socket.
newStatus | if true, sets the socket in blocking mode, if false set to non-blocking mode. If the socket is already in the target state, nothing is done. |
NonBlockingNotSupportedException | if the operation failed. |
Reimplemented from Ceylan::Network::Socket.
Definition at line 381 of file CeylanStreamSocket.cc.
References Ceylan::System::Stream::_isBlocking, Ceylan::System::explainError(), Ceylan::Network::explainSocketError(), Ceylan::Network::Socket::getOriginalFileDescriptor(), and Ceylan::toString().
Referenced by Ceylan::Network::AnonymousStreamSocket::AnonymousStreamSocket(), and Ceylan::Network::StreamSocket::createSocket().
void InputStream::setFaulty | ( | bool | newFaultyState = true |
) | [protected, inherited] |
Sets the faulty state of this stream.
newFaultyState | the new faulty state. |
Definition at line 1004 of file CeylanInputStream.cc.
References Ceylan::System::InputStream::_isFaulty.
Referenced by Ceylan::Network::MultiplexedServerStreamSocket::run().
void StreamSocket::setNagleAlgorithmTo | ( | bool | activated | ) | [protected, virtual, inherited] |
Enables or disables the Nagle algorithm for this socket.
activated | if true, activates the algorithm, if false, deactivates it. |
By default the Nagle algorithm is activated, as it should be used on most situations.
Definition at line 287 of file CeylanStreamSocket.cc.
References Ceylan::System::explainError(), Ceylan::Network::explainSocketError(), Ceylan::Network::Socket::getFileDescriptorForTransport(), and Ceylan::toString().
Referenced by Ceylan::Network::AnonymousStreamSocket::AnonymousStreamSocket(), connect(), and Ceylan::Network::ServerStreamSocket::prepareToAccept().
void TextDisplayable::SetOutputFormat | ( | TextOutputFormat | newOutputFormat | ) | [static, inherited] |
Sets the current overall text format to be used by TextDisplayable instances.
newOutputFormat | the new output format. |
Definition at line 72 of file CeylanTextDisplayable.cc.
References Ceylan::TextDisplayable::_OutputFormat.
Referenced by Ceylan::Log::LogHolder::LogHolder().
void InputStream::setSelected | ( | bool | newStatus | ) | [protected, virtual, inherited] |
Used to set the selection status of this stream.
Definition at line 989 of file CeylanInputStream.cc.
References Ceylan::System::InputStream::_isSelected, Ceylan::System::InputStream::getInputStreamID(), and Ceylan::toString().
Referenced by Ceylan::System::StandardFile::read(), Ceylan::System::Pipe::read(), and Ceylan::System::LibfatFile::read().
void InputStream::setStreamID | ( | StreamID | newInputStreamID | ) | [protected, virtual, inherited] |
Sets this input stream's unique ID.
InputStreamException | in all cases as long as not specifically overriden. |
Definition at line 1013 of file CeylanInputStream.cc.
void InputStream::skipWhitespaces | ( | Ceylan::Uint8 & | firstNonSpace | ) | [virtual, inherited] |
Reads from this input stream as long as there are whitespaces to be read.
firstNonSpace | the variable which will be set by this method to the value of the first non-whitespace character that is read. |
Definition at line 516 of file CeylanInputStream.cc.
References Ceylan::isWhitespace(), and Ceylan::System::InputStream::readUint8().
Referenced by Ceylan::XML::XMLParser::handleNextElement().
Ceylan::Uint16 InputStream::Test | ( | std::list< InputStream * > & | is | ) | [static, inherited] |
Checks whether bytes become available on one or more streams in is.
To see which are selected, use the isSelected
method.
This method returns always immediatly.
SelectFailedException | if the operation failed, for example if the file descriptor feature is not available on this platform. |
Definition at line 863 of file CeylanInputStream.cc.
References Ceylan::System::explainError(), and Ceylan::System::getError().
const std::string TextDisplayable::ToString | ( | std::list< TextDisplayable * > | displayables, | |
Ceylan::VerbosityLevels | level = Ceylan::high | |||
) | [static, inherited] |
Returns a user-friendly description of this list of pointers to text displayable instances.
displayables | a list of pointers to TextDisplayable instances/ | |
level | the requested verbosity level. |
Definition at line 45 of file CeylanTextDisplayable.cc.
References Ceylan::formatStringList().
const std::string ClientStreamSocket::toString | ( | Ceylan::VerbosityLevels | level = Ceylan::high |
) | const [virtual] |
Returns a user-friendly description of the state of this object.
level | the requested verbosity level. |
Reimplemented from Ceylan::Network::StreamSocket.
Definition at line 280 of file CeylanClientStreamSocket.cc.
References _serverHostInfo, _serverHostName, getPeerPort(), isConnected(), and Ceylan::Network::HostDNSEntry::toString().
Referenced by connect().
virtual System::Size Ceylan::Network::Socket::write | ( | const char * | buffer, | |
System::Size | maxLength | |||
) | [virtual, inherited] |
Writes up to maxLength bytes from the specified buffer to this socket.
buffer | the buffer where to find bytes that must be written to this socket. Its size must be at least maxLength bytes. |
WriteFailedException | if a write error occurred. |
Reimplemented from Ceylan::System::OutputStream.
Size Socket::write | ( | const std::string & | message | ) | [virtual, inherited] |
Writes message to this socket.
message | the message to write to this socket. |
WriteFailedException | if a write error occurred. |
Reimplemented from Ceylan::System::OutputStream.
Definition at line 294 of file CeylanSocket.cc.
References Ceylan::System::explainError(), Ceylan::System::FDWrite(), Ceylan::Network::Socket::getFileDescriptorForTransport(), and Ceylan::Exception::toString().
void OutputStream::writeFloat32 | ( | Ceylan::Float32 | toWrite | ) | [virtual, inherited] |
Writes a Ceylan::Uint32 to this output stream.
WriteFailedException | in case a system error occured. |
Definition at line 219 of file CeylanOutputStream.cc.
References ceylan_bswap_32, and Ceylan::System::OutputStream::write().
Referenced by Ceylan::Middleware::LightWeightMarshaller::encodeFloat32().
void OutputStream::writeFloat64 | ( | Ceylan::Float64 | toWrite | ) | [virtual, inherited] |
Writes a Ceylan::Uint32 to this output stream.
WriteFailedException | in case a system error occured. |
Definition at line 247 of file CeylanOutputStream.cc.
References Ceylan::byteswap(), ceylan_bswap_64, and Ceylan::System::OutputStream::write().
Referenced by Ceylan::Middleware::LightWeightMarshaller::encodeFloat64().
void OutputStream::writeSint16 | ( | Ceylan::Sint16 | toWrite | ) | [virtual, inherited] |
Writes a Ceylan::Sint16 to this output stream.
WriteFailedException | in case a system error occured. |
Definition at line 119 of file CeylanOutputStream.cc.
References ceylan_bswap_16, and Ceylan::System::OutputStream::write().
Referenced by Ceylan::Middleware::LightWeightMarshaller::encodeSint16().
void OutputStream::writeSint32 | ( | Ceylan::Sint32 | toWrite | ) | [virtual, inherited] |
Writes a Ceylan::Sint32 to this output stream.
WriteFailedException | in case a system error occured. |
Definition at line 169 of file CeylanOutputStream.cc.
References ceylan_bswap_32, and Ceylan::System::OutputStream::write().
Referenced by Ceylan::Middleware::LightWeightMarshaller::encodeSint32().
void OutputStream::writeSint8 | ( | Ceylan::Sint8 | toWrite | ) | [virtual, inherited] |
Writes a Ceylan::Sint8 to this output stream.
WriteFailedException | in case a system error occured. |
Definition at line 89 of file CeylanOutputStream.cc.
References Ceylan::System::OutputStream::write().
Referenced by Ceylan::Middleware::LightWeightMarshaller::encodeSint8().
void OutputStream::writeString | ( | const std::string & | toWrite | ) | [virtual, inherited] |
Writes a string to this output stream.
toWrite | the string to write to this output stream. |
WriteFailedException | in case a system error occured. |
Definition at line 286 of file CeylanOutputStream.cc.
References Ceylan::Log::LogPlug::debug(), Ceylan::toString(), Ceylan::Uint16Max, Ceylan::System::OutputStream::write(), and Ceylan::System::OutputStream::writeUint16().
Referenced by Ceylan::Middleware::LightWeightMarshaller::encodeString().
void OutputStream::writeUint16 | ( | Ceylan::Uint16 | toWrite | ) | [virtual, inherited] |
Writes a Ceylan::Uint16 to this output stream.
WriteFailedException | in case a system error occured. |
Definition at line 144 of file CeylanOutputStream.cc.
References ceylan_bswap_16, and Ceylan::System::OutputStream::write().
Referenced by Ceylan::Middleware::LightWeightMarshaller::encodeUint16(), and Ceylan::System::OutputStream::writeString().
void OutputStream::writeUint32 | ( | Ceylan::Uint32 | toWrite | ) | [virtual, inherited] |
Writes a Ceylan::Uint32 to this output stream.
WriteFailedException | in case a system error occured. |
Definition at line 194 of file CeylanOutputStream.cc.
References ceylan_bswap_32, and Ceylan::System::OutputStream::write().
Referenced by Ceylan::Middleware::LightWeightMarshaller::encodeUint32().
void OutputStream::writeUint8 | ( | Ceylan::Uint8 | toWrite | ) | [virtual, inherited] |
Writes a Ceylan::Uint8 to this output stream.
WriteFailedException | in case a system error occured. |
Definition at line 104 of file CeylanOutputStream.cc.
References Ceylan::System::OutputStream::write().
Referenced by Ceylan::Middleware::LightWeightMarshaller::encodeUint8(), and Ceylan::XML::XMLSavingVisitor::visit().
SystemSpecificSocketAddress* Ceylan::Network::Socket::_address [protected, inherited] |
The system-specific socket address for this socket.
It will be used by server sockets to bind to the target port, whereas client sockets will use it to connect to the target server, and anonymous sockets will store informations about the client.
Definition at line 454 of file CeylanSocket.h.
Referenced by Ceylan::Network::AnonymousStreamSocket::AnonymousStreamSocket(), connect(), Ceylan::Network::StreamSocket::createSocket(), Ceylan::Network::ServerStreamSocket::prepareToAccept(), Ceylan::Network::Socket::Socket(), and Ceylan::Network::Socket::~Socket().
bool Ceylan::System::Stream::_isBlocking [protected, inherited] |
Stores whether the stream is in blocking mode.
Definition at line 221 of file CeylanStream.h.
Referenced by Ceylan::System::Stream::isBlocking(), Ceylan::Network::StreamSocket::setBlocking(), Ceylan::Network::Socket::setBlocking(), and Ceylan::System::Stream::toString().
bool Ceylan::Network::StreamSocket::_nagleAlgorithmDeactivated [protected, inherited] |
Tells whether the Nagle algorithm is requested to be deactivated, so that the snappiest possible response (packet timing) is searched for (if true), even though it would be obtained at the expense of usable network bandwidth.
This is seldom recommended except for remote GUI or multiplayer network games.
Hence the default is false, and the Nagle algorithm is used.
Deactivating the Nagle algorithm is to be performed in socket child classes.
Definition at line 223 of file CeylanStreamSocket.h.
Referenced by Ceylan::Network::AnonymousStreamSocket::AnonymousStreamSocket(), connect(), Ceylan::Network::ServerStreamSocket::prepareToAccept(), and Ceylan::Network::StreamSocket::toString().
System::FileDescriptor Ceylan::Network::Socket::_originalFD [protected, inherited] |
Internal file descriptor, used if this feature is available.
The local port this socket will be bound to.
This is the original file descriptor for this socket. Depending on the specialization of this socket, it may or may not be the file descriptor that is used for transport.
Definition at line 472 of file CeylanSocket.h.
Referenced by Ceylan::Network::AnonymousStreamSocket::AnonymousStreamSocket(), Ceylan::Network::Socket::close(), Ceylan::Network::StreamSocket::createSocket(), Ceylan::Network::Socket::getFileDescriptorForTransport(), Ceylan::Network::Socket::getOriginalFileDescriptor(), and Ceylan::Network::AnonymousStreamSocket::toString().
TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited] |
The text format to be used currently by TextDisplayable instances.
Definition at line 158 of file CeylanTextDisplayable.h.
Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().
Port Ceylan::Network::Socket::_port [protected, inherited] |
The port this socket is created with.
For client sockets, the port of the remote server will be recorded here.
For server sockets, it will be the local port where the server will be listening.
Definition at line 441 of file CeylanSocket.h.
Referenced by Ceylan::Network::StreamSocket::createSocket(), Ceylan::Network::ServerStreamSocket::getLocalPort(), getPeerPort(), and Ceylan::Network::StreamSocket::StreamSocket().
DNS record for linked server.
It acts also like a flag telling whether the socket is currently connected.
Definition at line 234 of file CeylanClientStreamSocket.h.
Referenced by connect(), disconnect(), isConnected(), toString(), and ~ClientStreamSocket().
std::string Ceylan::Network::ClientStreamSocket::_serverHostName [private] |
The hostname of the server this socket is to be linked to.
Definition at line 224 of file CeylanClientStreamSocket.h.
Referenced by connect(), getServerName(), and toString().