#include <bmqt_uri.h>
List of all members.
Detailed Description
This component implements a mechanism, bmqt::UriBuilder
, that can be used for creating queue URI for BMQ.
See Component bmqt_uri
Constructor & Destructor Documentation
bmqt::UriBuilder::UriBuilder |
( |
bslma::Allocator * |
allocator = 0 |
) |
[explicit] |
Create a new UriBuilder using the optionally specified allocator
.
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
UriBuilder& bmqt::UriBuilder::setDomain |
( |
const bslstl::StringRef & |
value |
) |
|
UriBuilder& bmqt::UriBuilder::setTier |
( |
const bslstl::StringRef & |
value |
) |
|
UriBuilder& bmqt::UriBuilder::setQualifiedDomain |
( |
const bslstl::StringRef & |
value |
) |
|
UriBuilder& bmqt::UriBuilder::setQueue |
( |
const bslstl::StringRef & |
value |
) |
|
UriBuilder& bmqt::UriBuilder::setId |
( |
const bslstl::StringRef & |
value |
) |
|
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.
void bmqt::UriBuilder::reset |
( |
|
) |
|
Reset all fields of this builder.
int 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: