Provides the topic URI, options, and payload contained within WAMP PUBLISH messages. More...

#include <cppwamp/peerdata.hpp>

Inheritance diagram for wamp::Pub:

Public Member Functions
	Pub (String topic)
	Converting constructor taking a topic URI.

Subscriber Allow/Deny Lists
See Subscriber Black- and Whitelisting in the WAMP Specification
const String &	topic ()
	Obtains the topic URI.

Pub &	withExcludedSessions (Array sessionIds)
	Specifies the list of (potential) Subscriber session IDs that won't receive the published event. More...

Pub &	withExcludedAuthIds (Array authIds)
	Specifies a deny list of authid strings. More...

Pub &	withExcludedAuthRoles (Array authRoles)
	Specifies a deny list of authrole strings. More...

Pub &	withEligibleSessions (Array sessionIds)
	Specifies the list of (potential) Subscriber session IDs that are allowed to receive the published event. More...

Pub &	withEligibleAuthIds (Array authIds)
	Specifies an allow list of authid strings. More...

Pub &	withEligibleAuthRoles (Array authRoles)
	Specifies an allow list of authrole strings. More...

Publisher Exclusion
See Publisher Exclusion in the WAMP Specification
Pub &	withExcludeMe (bool excluded=true)
	Specifies if this session should be excluded from receiving the event. More...

Publisher Identification
See Publisher Identification in the WAMP Specification
Pub &	withDiscloseMe (bool disclosed=true)
	Requests that the identity (session ID) of this session be disclosed in the event. More...

Detailed Description

Provides the topic URI, options, and payload contained within WAMP PUBLISH messages.

Examples: examples/asynctimeservice/main.cpp, examples/chat/main.cpp, examples/coro20timeservice/main.cpp, examples/futuretimeservice/main.cpp, examples/stacklesstimeservice/main.cpp, and examples/timeservice/main.cpp.

Member Function Documentation

◆ withExcludedSessions()

Pub & wamp::Pub::withExcludedSessions ( Array sessionIds )

Specifies the list of (potential) Subscriber session IDs that won't receive the published event.

This sets the PUBLISH.Options.exclude|list option.

◆ withExcludedAuthIds()

Pub & wamp::Pub::withExcludedAuthIds ( Array authIds )

Specifies a deny list of authid strings.

This sets the PUBLISH.Options.exclude_authid|list option.

◆ withExcludedAuthRoles()

Pub & wamp::Pub::withExcludedAuthRoles ( Array authRoles )

Specifies a deny list of authrole strings.

This sets the PUBLISH.Options.exclude_authrole|list option.

◆ withEligibleSessions()

Pub & wamp::Pub::withEligibleSessions ( Array sessionIds )

Specifies the list of (potential) Subscriber session IDs that are allowed to receive the published event.

This sets the PUBLISH.Options.eligible|list option.

◆ withEligibleAuthIds()

Pub & wamp::Pub::withEligibleAuthIds ( Array authIds )

Specifies an allow list of authid strings.

This sets the PUBLISH.Options.eligible_authid|list option.

◆ withEligibleAuthRoles()

Pub & wamp::Pub::withEligibleAuthRoles ( Array authRoles )

Specifies an allow list of authrole strings.

This sets the PUBLISH.Options.eligible_authrole|list option.

◆ withExcludeMe()

Pub & wamp::Pub::withExcludeMe ( bool excluded = true )

Specifies if this session should be excluded from receiving the event.

This sets the PUBLISH.Options.exclude_me|bool option.

◆ withDiscloseMe()

Pub & wamp::Pub::withDiscloseMe ( bool disclosed = true )

Requests that the identity (session ID) of this session be disclosed in the event.

This sets the PUBLISH.Options.disclose_me|bool option.

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

cppwamp/peerdata.hpp
cppwamp/internal/peerdata.ipp

Public Member Functions