web::http::client::tools::EventSource Class Reference

#include <EventSource.h>

Inheritance diagram for web::http::client::tools::EventSource:

Collaboration diagram for web::http::client::tools::EventSource:

Classes
struct	MessageEvent
struct	SharedState

Public Types
enum class	ReadyState : int { CONNECTING = 0 , OPEN = 1 , CLOSED = 2 }

Public Member Functions
virtual	~EventSource ()
EventSource *	onMessage (std::function< void(const MessageEvent &)> messageCallback)
EventSource *	addEventListener (const std::string &key, std::function< void(const MessageEvent &)> eventListener)
EventSource *	removeEventListeners (const std::string &type)
EventSource *	onOpen (std::function< void()> onOpen)
EventSource *	onError (std::function< void()> onError)
EventSource::ReadyState	readyState () const
const std::string &	lastEventId () const
uint32_t	retry () const
EventSource *	retry (uint32_t retry)
virtual void	close ()=0

Protected Member Functions
	EventSource ()

Protected Attributes
std::shared_ptr< SharedState >	sharedState

Detailed Description

Definition at line 67 of file EventSource.h.

Member Enumeration Documentation

ReadyState

enum class web::http::client::tools::EventSource::ReadyState : int

strong

Enumerator
CONNECTING
OPEN
CLOSED

Definition at line 70 of file EventSource.h.

: int { CONNECTING = 0, OPEN = 1, CLOSED = 2 };

Constructor & Destructor Documentation

EventSource()

web::http::client::tools::EventSource::EventSource ( )

protected

Definition at line 50 of file EventSource.cpp.

        : sharedState(std::make_shared<SharedState>()) {
    }

References sharedState.

~EventSource()

web::http::client::tools::EventSource::~EventSource ( )

virtual

Reimplemented in web::http::legacy::in6::EventSource, web::http::legacy::in::EventSource, web::http::legacy::rc::EventSource, web::http::legacy::un::EventSource, web::http::tls::in6::EventSource, web::http::tls::in::EventSource, web::http::tls::rc::EventSource, and web::http::tls::un::EventSource.

Definition at line 54 of file EventSource.cpp.

                              {
    }

Member Function Documentation

addEventListener()

EventSource * web::http::client::tools::EventSource::addEventListener	(	const std::string &	key,
		std::function< void(const MessageEvent &)>	eventListener )

Definition at line 63 of file EventSource.cpp.

                                                                                                                         {
        sharedState->onEventListener[key].push_back(std::move(eventListener));
 
        return this;
    }

References web::http::client::tools::EventSource::SharedState::onEventListener, and sharedState.

close()

virtual void web::http::client::tools::EventSource::close ( )

pure virtual

Implemented in web::http::client::tools::EventSourceT< Client >, web::http::client::tools::EventSourceT< web::http::legacy::in6::Client >, web::http::client::tools::EventSourceT< web::http::legacy::in::Client >, web::http::client::tools::EventSourceT< web::http::legacy::rc::Client >, web::http::client::tools::EventSourceT< web::http::legacy::un::Client >, web::http::client::tools::EventSourceT< web::http::tls::in6::Client >, web::http::client::tools::EventSourceT< web::http::tls::in::Client >, web::http::client::tools::EventSourceT< web::http::tls::rc::Client >, and web::http::client::tools::EventSourceT< web::http::tls::un::Client >.

lastEventId()

const std::string & web::http::client::tools::EventSource::lastEventId

(

)

const

Definition at line 91 of file EventSource.cpp.

                                                    {
        return sharedState->lastId;
    }

References web::http::client::tools::EventSource::SharedState::lastId, and sharedState.

onError()

EventSource * web::http::client::tools::EventSource::onError

(

std::function< void()>

onError

)

Definition at line 81 of file EventSource.cpp.

                                                                 {
        sharedState->onErrorListener.push_back(std::move(onError));
 
        return this;
    }

References web::http::client::tools::EventSource::SharedState::onErrorListener, and sharedState.

onMessage()

EventSource * web::http::client::tools::EventSource::onMessage

(

std::function< void(const MessageEvent &)>

messageCallback

)

Definition at line 57 of file EventSource.cpp.

                                                                                              {
        sharedState->onMessageListener.push_back(std::move(messageCallback));
 
        return this;
    }

References web::http::client::tools::EventSource::SharedState::onMessageListener, and sharedState.

onOpen()

EventSource * web::http::client::tools::EventSource::onOpen

(

std::function< void()>

onOpen

)

Definition at line 75 of file EventSource.cpp.

                                                               {
        sharedState->onOpenListener.push_back(std::move(onOpen));
 
        return this;
    }

References web::http::client::tools::EventSource::SharedState::onOpenListener, and sharedState.

readyState()

EventSource::ReadyState web::http::client::tools::EventSource::readyState

(

)

const

Definition at line 87 of file EventSource.cpp.

                                                        {
        return sharedState->ready;
    }

References web::http::client::tools::EventSource::SharedState::ready, and sharedState.

removeEventListeners()

EventSource * web::http::client::tools::EventSource::removeEventListeners

(

const std::string &

type

)

Definition at line 69 of file EventSource.cpp.

                                                                        {
        sharedState->onEventListener.erase(type);
 
        return this;
    }

References web::http::client::tools::EventSource::SharedState::onEventListener, and sharedState.

retry() [1/2]

uint32_t web::http::client::tools::EventSource::retry

(

)

const

Definition at line 95 of file EventSource.cpp.

                                      {
        return sharedState->retry;
    }

References web::http::client::tools::EventSource::SharedState::retry, and sharedState.

retry() [2/2]

EventSource * web::http::client::tools::EventSource::retry

(

uint32_t

retry

)

Definition at line 99 of file EventSource.cpp.

                                                  {
        sharedState->retry = retry;
 
        return this;
    }

References web::http::client::tools::EventSource::SharedState::retry, and sharedState.

Member Data Documentation

sharedState

std::shared_ptr<SharedState> web::http::client::tools::EventSource::sharedState

protected

Definition at line 117 of file EventSource.h.

Referenced by addEventListener(), web::http::client::tools::EventSourceT< web::http::legacy::in::Client >::close(), EventSource(), web::http::client::tools::EventSourceT< web::http::legacy::in::Client >::init(), lastEventId(), onError(), onMessage(), onOpen(), readyState(), removeEventListeners(), retry(), and retry().

---

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

• web/http/client/tools/EventSource.h
• web/http/client/tools/EventSource.cpp