Hyper API for C++  0.0.15888
Hyper client library for C++ applications
hyperapi::Endpoint Class Referencefinal

Describes a network endpoint at which a Hyper server is accessible. More...

#include <Endpoint.hpp>

Public Member Functions

 Endpoint (std::string connectionDescriptor, std::string userAgent)
 Creates an Endpoint from the given connection descriptor. More...
 
const std::string & getConnectionDescriptor () const
 Returns the connection descriptor. More...
 
const std::string & getUserAgent () const
 Returns the user agent. More...
 

Detailed Description

Describes a network endpoint at which a Hyper server is accessible.

Definition at line 14 of file Endpoint.hpp.

Constructor & Destructor Documentation

◆ Endpoint()

hyperapi::Endpoint::Endpoint ( std::string  connectionDescriptor,
std::string  userAgent 
)
inline

Creates an Endpoint from the given connection descriptor.

The descriptor is expected to be a tableau IPC descriptor (e.g., tab.tcp://localhost:7483).

Parameters
connectionDescriptorThe tableau IPC connection descriptor string
userAgentA user agent string, which will be used in telemetry and logging. Note: This string will be sent to Tableau as part of telemetry data.

Definition at line 24 of file Endpoint.hpp.

Member Function Documentation

◆ getConnectionDescriptor()

const std::string& hyperapi::Endpoint::getConnectionDescriptor ( ) const
inline

Returns the connection descriptor.

Returns
The connection descriptor

Definition at line 32 of file Endpoint.hpp.

◆ getUserAgent()

const std::string& hyperapi::Endpoint::getUserAgent ( ) const
inline

Returns the user agent.

Returns
The user agent

Definition at line 38 of file Endpoint.hpp.


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