Pandora::Request Class Reference

Pandora request class. More...

#include <pandoramessages.h>

Inheritance diagram for Pandora::Request:

Collaboration diagram for Pandora::Request:

Public Types
using	Option = RequestOption

Public Member Functions
const std::string &	url () const
bool	debug () const
bool	tlsEncrypt () const
bool	blowfishEncrypt () const
Parsnip::Data &	retrieveRequestMessage ()
	Retrieve the Parsnip Data object with the request message. More...
virtual void	extractResponse (const Parsnip::Data &message)=0
	Decode a response message, already converted to Parsnip Data, into some internal representation. More...

Protected Member Functions
	Request (Source *const src, const char *ep, Option options=Option::NONE)
	RPC method name or REST API endpoint. More...

Protected Attributes
Source *const	source
Parsnip::Data	request_message

Private Attributes
Option	flags
const std::string	endpoint

Detailed Description

Pandora request class.

This provides a framework for assembling requests and decoding responses.

Member Typedef Documentation

Option

using Pandora::Request::Option = RequestOption

Constructor & Destructor Documentation

Request()

Pandora::Request::Request ( Source *const  src, const char *  ep, Option  options = Option::NONE  )

protected

RPC method name or REST API endpoint.

Member Function Documentation

blowfishEncrypt()

bool Pandora::Request::blowfishEncrypt ( ) const

inline

Here is the caller graph for this function:

debug()

bool Pandora::Request::debug ( ) const

inline

Here is the caller graph for this function:

extractResponse()

virtual void Pandora::Request::extractResponse ( const Parsnip::Data &  message )

pure virtual

Decode a response message, already converted to Parsnip Data, into some internal representation.

Parameters

message

The message to be decoded.

Implemented in Pandora::RetrieveAdvert, Pandora::SearchRequest, Pandora::RequestQueueTracks, Pandora::RequestAddFeedback, Pandora::RequestAddStationSeed, Pandora::RequestStationDetails, Pandora::RequestRenameStation, Pandora::RequestTransformStation, Pandora::RequestCreateStation, Pandora::RequestGenreStationList, Pandora::RequestStationListChecksum, Pandora::RequestStationList, Pandora::Notification, Pandora::AuthorizationRequest, and Pandora::PartnerLoginRequest.

Here is the caller graph for this function:

retrieveRequestMessage()

Parsnip::Data & Pandora::Request::retrieveRequestMessage

(

)

Retrieve the Parsnip Data object with the request message.

It would be better off returned const, but efficiency.

Returns

Data containing serializable form of request.

Here is the call graph for this function:

Here is the caller graph for this function:

tlsEncrypt()

bool Pandora::Request::tlsEncrypt ( ) const

inline

Here is the caller graph for this function:

url()

const std::string& Pandora::Request::url ( ) const

inline

Here is the caller graph for this function:

Member Data Documentation

endpoint

const std::string Pandora::Request::endpoint

private

flags

Option Pandora::Request::flags

private

request_message

Parsnip::Data Pandora::Request::request_message

protected

source

Source* const Pandora::Request::source

protected

---

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

• mediaunits/pandora/pandoramessages.h
• mediaunits/pandora/pandoramessages.cpp