ofxHTTP
A collection of tools for HTTP.
ofx::HTTP::BasePostEventArgs Class Reference

A base class for a POST event dataÊcallback. More...

#include <PostRouteEvents.h>

Inheritance diagram for ofx::HTTP::BasePostEventArgs:
ofx::HTTP::ServerEventArgs ofx::HTTP::PostEventArgs ofx::HTTP::PostFormEventArgs ofx::HTTP::PostUploadEventArgs

Public Member Functions

 BasePostEventArgs (ServerEventArgs &e, const std::string &postId)
 
virtual ~BasePostEventArgs ()
 Destroy the BasePostEventArgs.
 
const std::string & getPostId () const
 The post id. More...
 
- Public Member Functions inherited from ofx::HTTP::ServerEventArgs
 ServerEventArgs (Poco::Net::HTTPServerRequest &request, Poco::Net::HTTPServerResponse &response, AbstractSession &session)
 Construct the ServerEventArgs. More...
 
virtual ~ServerEventArgs ()
 Destroy the ServerEventArgs.
 
Poco::Net::HTTPServerRequest & request ()
 Get the Poco::Net::HTTPServerRequest. More...
 
Poco::Net::HTTPServerResponse & response ()
 Get the Poco::Net::HTTPServerResponse. More...
 
AbstractSessionsession ()
 Get the session associated with this event. More...
 

Protected Attributes

std::string _postId
 The post id.
 
- Protected Attributes inherited from ofx::HTTP::ServerEventArgs
Poco::Net::HTTPServerRequest & _request
 A reference to the server request.
 
Poco::Net::HTTPServerResponse & _response
 Callbacks are permitted to set the response. More...
 
AbstractSession_session
 The session associated with the event.
 

Detailed Description

A base class for a POST event dataÊcallback.

Constructor & Destructor Documentation

◆ BasePostEventArgs()

ofx::HTTP::BasePostEventArgs::BasePostEventArgs ( ServerEventArgs e,
const std::string &  postId 
)
inline

a BasePostEventArgs.

Parameters
eThe server event data associated with this post.
postIdThe post id associated with this post data.

Member Function Documentation

◆ getPostId()

const std::string& ofx::HTTP::BasePostEventArgs::getPostId ( ) const
inline

The post id.

Each time a POST request, is processed it is assigned a unique id. This id allows us to track post progress updates and multi-part posts.

Returns
the session id or null UUID if not set.

The documentation for this class was generated from the following file: