Library: Net
Package: HTTP
Header: Poco/Net/HTTPSession.h
HTTPSession implements basic HTTP session management for both HTTP clients and HTTP servers.
HTTPSession implements buffering for HTTP connections, as well as specific support for the various HTTP stream classes.
This class can not be instantiated. HTTPClientSession or HTTPServerSession must be used instead.
Known Derived Classes: HTTPClientSession, HTTPServerSession, HTTPSClientSession
Member Functions: abort, attachSessionData, attachSocket, buffered, close, connect, connected, detachSocket, get, getKeepAlive, getTimeout, networkException, peek, read, receive, refill, sessionData, setException, setKeepAlive, setTimeout, socket, write
HTTP_PORT = 80
HTTPSession();
Creates a HTTP session using an unconnected stream socket.
HTTPSession(
const StreamSocket & socket
);
Creates a HTTP session using the given socket. The session takes ownership of the socket and closes it when it's no longer used.
HTTPSession(
const StreamSocket & socket,
bool keepAlive
);
Creates a HTTP session using the given socket. The session takes ownership of the socket and closes it when it's no longer used.
virtual ~HTTPSession();
Destroys the HTTPSession and closes the underlying socket.
virtual void abort();
Aborts a session in progress by shutting down and closing the underlying socket.
void attachSessionData(
const Poco::Any & data
);
Allows to attach an application-specific data item to the session.
On the server side, this can be used to manage data that must be maintained over the entire lifetime of a persistent connection (that is, multiple requests sent over the same connection).
bool connected() const;
Returns true if the underlying socket is connected.
StreamSocket detachSocket();
Detaches the socket from the session.
The socket is returned, and a new, uninitialized socket is attached to the session.
bool getKeepAlive() const;
Returns the value of the keep-alive flag for this session.
Poco::Timespan getTimeout() const;
Returns the timeout for the HTTP session.
const Poco::Exception * networkException() const;
If sending or receiving data over the underlying socket connection resulted in an exception, a pointer to this exception is returned.
Otherwise, NULL is returned.
const Poco::Any & sessionData() const;
Returns the data attached with attachSessionData(), or an empty Poco::Any if no user data has been attached.
void setKeepAlive(
bool keepAlive
);
Sets the keep-alive flag for this session.
If the keep-alive flag is enabled, persistent HTTP/1.1 connections are supported.
void setTimeout(
const Poco::Timespan & timeout
);
Sets the timeout for the HTTP session.
StreamSocket & socket();
Returns a reference to the underlying socket.
void attachSocket(
const StreamSocket & socket
);
Attaches a socket to the session, replacing the previously attached socket.
int buffered() const;
Returns the number of bytes in the buffer.
void close();
Closes the underlying socket.
virtual void connect(
const SocketAddress & address
);
Connects the underlying socket to the given address and sets the socket's receive timeout.
int get();
Returns the next byte in the buffer. Reads more data from the socket if there are no bytes left in the buffer.
int peek();
Peeks at the next character in the buffer. Reads more data from the socket if there are no bytes left in the buffer.
virtual int read(
char * buffer,
std::streamsize length
);
Reads up to length bytes.
If there is data in the buffer, this data is returned. Otherwise, data is read from the socket to avoid unnecessary buffering.
int receive(
char * buffer,
int length
);
Reads up to length bytes.
void refill();
Refills the internal buffer.
void setException(
const Poco::Exception & exc
);
Stores a clone of the exception.
virtual int write(
const char * buffer,
std::streamsize length
);
Writes data to the socket.