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.

const std::string &	getConnectionDescriptor () const
	Returns the connection descriptor.

const std::string &	getUserAgent () const
	Returns the user agent.

Detailed Description

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

Definition at line 14 of file Endpoint.hpp.

Constructor & Destructor Documentation

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

connectionDescriptor	The tableau IPC connection descriptor string
userAgent	A 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.

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

inline

Returns the connection descriptor.

Definition at line 32 of file Endpoint.hpp.

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

inline

Returns the user agent.

Definition at line 38 of file Endpoint.hpp.

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