generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2024-12-13 02:22:57 +01:00
Code Issues Projects Releases Wiki Activity

documentation fixes

Browse Source
This commit is contained in:
Marian Krivos 2012-07-31 05:47:28 +00:00
parent fe0ba56dc4
commit a31370fa55
5 changed files with 60 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Net/include/Poco/Net/HTTPServer.h
View File

@ -76,16 +76,26 @@ public:
HTTPServer(HTTPRequestHandlerFactory::Ptr pFactory, const ServerSocket& socket, HTTPServerParams::Ptr pParams);
/// Creates the HTTPServer, using the given ServerSocket.
///
/// New threads are taken from the default thread pool.
/// The server takes ownership of the HTTPRequstHandlerFactory
/// and deletes it when it's no longer needed.
///
/// The server also takes ownership of the HTTPServerParams object.
///
/// News threads are taken from the default thread pool.
HTTPServer(HTTPRequestHandlerFactory::Ptr pFactory, Poco::ThreadPool& threadPool, const ServerSocket& socket, HTTPServerParams::Ptr pParams);
/// Creates the HTTPServer, using the given ServerSocket.
///
/// New threads are taken from the given thread pool.
/// The server takes ownership of the HTTPRequstHandlerFactory
/// and deletes it when it's no longer needed.
///
/// The server also takes ownership of the HTTPServerParams object.
///
/// News threads are taken from the given thread pool.
~HTTPServer();
/// Destroys the HTTPServer and its HTTPRequestHandlerFactory.
void stopAll(bool abortCurrent = false);
/// Stops the server. In contrast to TCPServer::stop(), which also
/// stops the server, but allows all client connections to finish at
@ -95,7 +105,7 @@ public:
/// complete. If abortCurrent is false, the underlying sockets of
/// all client connections are shut down, causing all requests
/// to abort.
private:
HTTPRequestHandlerFactory::Ptr _pFactory;
};

26
Net/include/Poco/Net/MulticastSocket.h
View File

@ -80,14 +80,14 @@ public:
~MulticastSocket();
/// Destroys the DatagramSocket.
MulticastSocket& operator = (const Socket& socket);
MulticastSocket& operator =(const Socket& socket);
/// Assignment operator.
///
/// Releases the socket's SocketImpl and
/// attaches the SocketImpl from the other socket and
/// increments the reference count of the SocketImpl.
/// increments the reference count of the SocketImpl.
void setInterface(const NetworkInterface& interfc);
void setInterface(const NetworkInterface& interface);
/// Sets the interface used for sending multicast packets.
///
/// To select the default interface, specify an empty
@ -95,39 +95,39 @@ public:
///
/// This is done by setting the IP_MULTICAST_IF/IPV6_MULTICAST_IF
/// socket option.
NetworkInterface getInterface() const;
/// Returns the interface used for sending multicast packets.
void setLoopback(bool flag);
/// Enable or disable loopback for multicast packets.
///
/// Sets the value of the IP_MULTICAST_LOOP/IPV6_MULTICAST_LOOP
/// socket option.
bool getLoopback() const;
/// Returns true iff loopback for multicast packets is enabled,
/// false otherwise.
void setTimeToLive(unsigned value);
/// Specifies the TTL/hop limit for outgoing packets.
///
/// Sets the value of the IP_MULTICAST_TTL/IPV6_MULTICAST_HOPS
/// socket option.
unsigned getTimeToLive() const;
/// Returns the TTL/hop limit for outgoing packets.
void joinGroup(const IPAddress& groupAddress);
/// Joins the specified multicast group at the default interface.
void joinGroup(const IPAddress& groupAddress, const NetworkInterface& interfc);
void joinGroup(const IPAddress& groupAddress, const NetworkInterface& interface);
/// Joins the specified multicast group at the given interface.
void leaveGroup(const IPAddress& groupAddress);
/// Leaves the specified multicast group at the default interface.
void leaveGroup(const IPAddress& groupAddress, const NetworkInterface& interfc);
void leaveGroup(const IPAddress& groupAddress, const NetworkInterface& interface);
/// Leaves the specified multicast group at the given interface.
};

32
Net/include/Poco/Net/SocketImpl.h
View File

@ -105,7 +105,7 @@ public:
///
/// If reuseAddress is true, sets the SO_REUSEADDR
/// socket option.
virtual void bind6(const SocketAddress& address, bool reuseAddress = false, bool ipV6Only = false);
/// Bind a local IPv6 address to the socket.
///
@ -122,7 +122,7 @@ public:
///
/// If the library has not been built with IPv6 support,
/// a Poco::NotImplementedException will be thrown.
virtual void listen(int backlog = 64);
/// Puts the socket into listening state.
///
@ -352,35 +352,37 @@ public:
virtual bool getBlocking() const;
/// Returns the blocking mode of the socket.
/// This method will only work if the blocking modes of
/// the socket are changed via the setBlocking method!
virtual bool secure() const;
/// Returns true iff the socket's connection is secure
/// (using SSL or TLS).
int socketError();
/// Returns the value of the SO_ERROR socket option.
poco_socket_t sockfd() const;
/// Returns the socket descriptor for the
/// Returns the socket descriptor for the
/// underlying native socket.
void ioctl(poco_ioctl_request_t request, int& arg);
/// A wrapper for the ioctl system call.
void ioctl(poco_ioctl_request_t request, void* arg);
/// A wrapper for the ioctl system call.
#if defined(POCO_OS_FAMILY_UNIX)
int fcntl(poco_fcntl_request_t request);
/// A wrapper for the fcntl system call.
int fcntl(poco_fcntl_request_t request, long arg);
/// A wrapper for the fcntl system call.
#if defined(POCO_OS_FAMILY_UNIX)
int fcntl(poco_fcntl_request_t request);
/// A wrapper for the fcntl system call.
int fcntl(poco_fcntl_request_t request, long arg);
/// A wrapper for the fcntl system call.
#endif
bool initialized() const;
/// Returns true iff the underlying socket is initialized.
protected:
SocketImpl();
/// Creates a SocketImpl.
@ -418,7 +420,7 @@ protected:
void reset(poco_socket_t fd = POCO_INVALID_SOCKET);
/// Allows subclasses to set the socket manually, iff no valid socket is set yet.
static int lastError();
/// Returns the last error code.

14
Net/include/Poco/Net/TCPServer.h
View File

@ -101,6 +101,10 @@ public:
TCPServer(TCPServerConnectionFactory::Ptr pFactory, const ServerSocket& socket, TCPServerParams::Ptr pParams = 0);
/// Creates the TCPServer, using the given ServerSocket.
///
/// The server takes ownership of the TCPServerConnectionFactory
/// and deletes it when it's no longer needed.
///
/// The server also takes ownership of the TCPServerParams object.
/// If no TCPServerParams object is given, the server's TCPServerDispatcher
/// creates its own one.
///
@ -109,6 +113,10 @@ public:
TCPServer(TCPServerConnectionFactory::Ptr pFactory, Poco::ThreadPool& threadPool, const ServerSocket& socket, TCPServerParams::Ptr pParams = 0);
/// Creates the TCPServer, using the given ServerSocket.
///
/// The server takes ownership of the TCPServerConnectionFactory
/// and deletes it when it's no longer needed.
///
/// The server also takes ownership of the TCPServerParams object.
/// If no TCPServerParams object is given, the server's TCPServerDispatcher
/// creates its own one.
///
@ -116,11 +124,11 @@ public:
virtual ~TCPServer();
/// Destroys the TCPServer and its TCPServerConnectionFactory.
const TCPServerParams& params() const;
/// Returns a const reference to the TCPServerParam object
/// used by the server's TCPServerDispatcher.
void start();
/// Starts the server. A new thread will be
/// created that waits for and accepts incoming
@ -128,7 +136,7 @@ public:
///
/// Before start() is called, the ServerSocket passed to
/// TCPServer must have been bound and put into listening state.
void stop();
/// Stops the server.
///

6
Net/include/Poco/Net/TCPServerDispatcher.h
View File

@ -61,10 +61,14 @@ class Net_API TCPServerDispatcher: public Poco::Runnable
public:
TCPServerDispatcher(TCPServerConnectionFactory::Ptr pFactory, Poco::ThreadPool& threadPool, TCPServerParams::Ptr pParams);
/// Creates the TCPServerDispatcher.
///
/// The dispatcher takes ownership of the TCPServerParams object.
/// If no TCPServerParams object is supplied, the TCPServerDispatcher
/// creates one.
void duplicate();
/// Increments the object's reference count.
void release();
/// Decrements the object's reference count
/// and deletes the object if the count