BloombergLP::bmqt::UriBuilder Class Reference

#include <bmqt_uri.h>

Public Member Functions
	UriBuilder (bslma::Allocator *allocator=0)
	Create a new UriBuilder using the optionally specified allocator. More...
	UriBuilder (const bmqt::Uri &uri, bslma::Allocator *allocator=0)
UriBuilder &	setDomain (const bslstl::StringRef &value)
UriBuilder &	setTier (const bslstl::StringRef &value)
UriBuilder &	setQualifiedDomain (const bslstl::StringRef &value)
UriBuilder &	setQueue (const bslstl::StringRef &value)
UriBuilder &	setId (const bslstl::StringRef &value)
void	reset ()
	Reset all fields of this builder. More...
int	uri (Uri *result, bsl::string *errorDescription=0) const

Detailed Description

This component implements a mechanism, bmqt::UriBuilder, that can be used for creating queue URI for BMQ.

Constructor & Destructor Documentation

UriBuilder() [1/2]

BloombergLP::bmqt::UriBuilder::UriBuilder ( bslma::Allocator *  allocator = 0 )

explicit

UriBuilder() [2/2]

BloombergLP::bmqt::UriBuilder::UriBuilder ( const bmqt::Uri &  uri, bslma::Allocator *  allocator = 0  )

explicit

Create a new UriBuilder initialized with the specified uri and using the optionally specified allocator.

Member Function Documentation

setDomain()

UriBuilder & BloombergLP::bmqt::UriBuilder::setDomain ( const bslstl::StringRef &  value )

inline

setTier()

UriBuilder & BloombergLP::bmqt::UriBuilder::setTier ( const bslstl::StringRef &  value )

inline

setQualifiedDomain()

UriBuilder& BloombergLP::bmqt::UriBuilder::setQualifiedDomain

(

const bslstl::StringRef &

value

)

setQueue()

UriBuilder & BloombergLP::bmqt::UriBuilder::setQueue ( const bslstl::StringRef &  value )

inline

setId()

UriBuilder & BloombergLP::bmqt::UriBuilder::setId ( const bslstl::StringRef &  value )

inline

Set the corresponding field of the URI to the specified value. The behavior is undefined unless value remains valid until URI has been built by invoking uri(). setDomain() and setTier() should be preferred over setQualifiedDomain() whenever possible.

reset()

void BloombergLP::bmqt::UriBuilder::reset

(

)

uri()

int BloombergLP::bmqt::UriBuilder::uri	(	Uri *	result,
		bsl::string *	errorDescription = 0
	)		const

Build and populate the specified result with the built URI, returning 0 on success, or return non-zero on error, populating the optionally specified errorDescription if provided.

---

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

• bmqt/bmqt_uri.h