alexaClientSDK::acl::TransportInterface Class Reference

#include <TransportInterface.h>

Inheritance diagram for alexaClientSDK::acl::TransportInterface:

Collaboration diagram for alexaClientSDK::acl::TransportInterface:

Public Member Functions
	TransportInterface ()
virtual bool	connect ()=0
virtual void	disconnect ()=0
virtual bool	isConnected ()=0
virtual void	onRequestEnqueued ()=0
virtual void	onWakeConnectionRetry ()=0
virtual void	onWakeVerifyConnectivity ()=0
	TransportInterface (const TransportInterface &rhs)=delete
TransportInterface &	operator= (const TransportInterface &rhs)=delete
virtual	~TransportInterface ()=default
Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)
virtual	~RequiresShutdown ()
	Destructor. More...
const std::string &	name () const
void	shutdown ()
bool	isShutdown () const

Additional Inherited Members
Protected Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
virtual void	doShutdown ()=0

Detailed Description

This class defines the interface which must be implemented to represent the creation and management of a specific connection to AVS.

Constructor & Destructor Documentation

TransportInterface() [1/2]

alexaClientSDK::acl::TransportInterface::TransportInterface ( )

inline

TransportInterface constructor.

TransportInterface() [2/2]

alexaClientSDK::acl::TransportInterface::TransportInterface ( const TransportInterface &  rhs )

delete

Deleted copy constructor

Parameters

rhs	The 'right hand side' to not copy.

~TransportInterface()

virtual alexaClientSDK::acl::TransportInterface::~TransportInterface ( )

virtualdefault

Destructor.

Member Function Documentation

connect()

virtual bool alexaClientSDK::acl::TransportInterface::connect ( )

pure virtual

Initiate a connection to AVS. This function may operate asynchronously, meaning its return value does not imply a successful connection, but that an attempt to connect has been successfully started. This function may not be thread-safe.

Returns

If connection setup was successful.

Implemented in alexaClientSDK::acl::HTTP2Transport.

disconnect()

virtual void alexaClientSDK::acl::TransportInterface::disconnect ( )

pure virtual

Disconnect from AVS. This function may not be thread-safe.

Implemented in alexaClientSDK::acl::HTTP2Transport.

isConnected()

virtual bool alexaClientSDK::acl::TransportInterface::isConnected ( )

pure virtual

Returns whether this object is currently connected to AVS.

Returns

If the object is currently connected to AVS.

Implemented in alexaClientSDK::acl::HTTP2Transport.

onRequestEnqueued()

virtual void alexaClientSDK::acl::TransportInterface::onRequestEnqueued ( )

pure virtual

A message request has been added to the shared synchronized queue and is ready to be read.

Implemented in alexaClientSDK::acl::HTTP2Transport.

onWakeConnectionRetry()

virtual void alexaClientSDK::acl::TransportInterface::onWakeConnectionRetry ( )

pure virtual

This method is a hint to retry connecting (if not connected).

Implemented in alexaClientSDK::acl::HTTP2Transport.

onWakeVerifyConnectivity()

virtual void alexaClientSDK::acl::TransportInterface::onWakeVerifyConnectivity ( )

pure virtual

This method is a hint to verify that there is a valid connection ot AVS.

Implemented in alexaClientSDK::acl::HTTP2Transport.

operator=()

TransportInterface& alexaClientSDK::acl::TransportInterface::operator= ( const TransportInterface &  rhs )

delete

Deleted assignment operator

Parameters

rhs	The 'right hand side' to not copy.

---

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

• /workplace/avs-device-sdk/ACL/include/ACL/Transport/TransportInterface.h