Pandora::ConnectionParameters Struct Reference

Pandora connection and source settings. More...

#include <pandoraparameters.h>

Inheritance diagram for Pandora::ConnectionParameters:

Collaboration diagram for Pandora::ConnectionParameters:

Public Member Functions
	ConnectionParameters ()
	ConnectionParameters (const ConnectionParameters &params)=default
	ConnectionParameters (ConnectionParameters &&params)=default
	ConnectionParameters (const UserData::JSONData &src)
	Create new connection parameters, retrieving values from user settings. More...
virtual bool	persist (UserData::JSONData &dest) const override
	Copy connection parameters into a user settings dictionary. More...
void	extractOptions (const Parsnip::Data &options)
Public Member Functions inherited from Media::SourceParameters
	SourceParameters (void)
	SourceParameters (Ownership::Type perm, User *user=nullptr)
	SourceParameters (Ownership::Type perm, const std::string &sourcename)
	SourceParameters (const UserData::JSONData &src)
virtual	~SourceParameters ()
void	extractOptions (const Parsnip::Data &options)

Static Public Member Functions
static Parsnip::OptionParser::Definitions	parser_definitions ()
Static Public Member Functions inherited from Media::SourceParameters
static const Parsnip::OptionParser::Definitions &	parser_definitions ()

Public Attributes
std::string	proxy
std::string	control_proxy
std::string	username
std::string	password
int	pause_timeout { 1800 }
int	playlist_expiration { 3600 }
int	cache_minimum { 4000 }
int	cache_maximum { 5000 }
JSONProtocolParameters	protocol
Public Attributes inherited from Media::SourceParameters
ProxyMode	song_proxy = ProxyMode::None
User *	owner = nullptr
Ownership::Type	permissions = Ownership::Type::PRIVATE
PersistenceMode	persistence = PersistenceMode::Temporary
	Persistence state. More...
std::string	name
bool	waitForReady = false
	Wait on initialization. Flag never persisted. More...

Private Member Functions
void	extract (const Parsnip::Data &options)

Detailed Description

Pandora connection and source settings.

Constructor & Destructor Documentation

ConnectionParameters() [1/4]

Pandora::ConnectionParameters::ConnectionParameters

(

void

)

ConnectionParameters() [2/4]

Pandora::ConnectionParameters::ConnectionParameters ( const ConnectionParameters &  params )

default

ConnectionParameters() [3/4]

Pandora::ConnectionParameters::ConnectionParameters ( ConnectionParameters &&  params )

default

ConnectionParameters() [4/4]

Pandora::ConnectionParameters::ConnectionParameters

(

const UserData::JSONData &

src

)

Create new connection parameters, retrieving values from user settings.

Parameters

src	A user settings dictionary to retrieve settings from.

Exceptions

invalid_argument

if values in the settings dictionary are invalid.

Here is the call graph for this function:

Member Function Documentation

extract()

void Pandora::ConnectionParameters::extract ( const Parsnip::Data &  options )

private

Here is the call graph for this function:

Here is the caller graph for this function:

extractOptions()

void Pandora::ConnectionParameters::extractOptions

(

const Parsnip::Data &

options

)

Here is the call graph for this function:

Here is the caller graph for this function:

parser_definitions()

Parsnip::OptionParser::Definitions Pandora::ConnectionParameters::parser_definitions ( void  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

persist()

bool Pandora::ConnectionParameters::persist ( UserData::JSONData &  dest ) const

overridevirtual

Copy connection parameters into a user settings dictionary.

Reimplemented from Media::SourceParameters.

Here is the call graph for this function:

Member Data Documentation

cache_maximum

int Pandora::ConnectionParameters::cache_maximum { 5000 }

cache_minimum

int Pandora::ConnectionParameters::cache_minimum { 4000 }

control_proxy

std::string Pandora::ConnectionParameters::control_proxy

password

std::string Pandora::ConnectionParameters::password

pause_timeout

int Pandora::ConnectionParameters::pause_timeout { 1800 }

playlist_expiration

int Pandora::ConnectionParameters::playlist_expiration { 3600 }

protocol

JSONProtocolParameters Pandora::ConnectionParameters::protocol

proxy

std::string Pandora::ConnectionParameters::proxy

username

std::string Pandora::ConnectionParameters::username

---

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

• mediaunits/pandora/pandoraparameters.h
• mediaunits/pandora/pandoraparameters.cpp