HostSession Class Reference

The HostSession is a manager-facing class that represents a discrete API session started by a host in order to communicate with a manager. More...

#include <HostSession.hpp>

Public Types
using	Ptr = HostSessionPtr
using	ConstPtr = HostSessionConstPtr

Public Member Functions
const HostPtr &	host () const
const log::LoggerInterfacePtr &	logger () const

Static Public Member Functions
static HostSessionPtr	make (HostPtr host, log::LoggerInterfacePtr logger)
	Constructs a new HostSession holding the supplied host. More...

Detailed Description

The HostSession is a manager-facing class that represents a discrete API session started by a host in order to communicate with a manager.

Any generalised API interactions a Manager may wish to make with a Host should be performed through the HostSession instance supplied with any ManagerInterface entrypoint. These objects should not be directly constructed, cached or otherwise persisted by a Manager.

The HostSession provides access to:

• A concrete instance of the Host, implemented by the tool or application that initiated the API session.
• A concrete instance of the LoggerInterface, to be used for all message reporting.

See also

Host

LoggerInterface

Member Typedef Documentation

using ConstPtr = HostSessionConstPtr

using Ptr = HostSessionPtr

Member Function Documentation

const HostPtr& host

(

)

const

Returns

The host that initiated the API session.

const log::LoggerInterfacePtr& logger

(

)

const

Returns

The logger associated with this session

static HostSessionPtr make ( HostPtr  host, log::LoggerInterfacePtr  logger  )

static

Constructs a new HostSession holding the supplied host.

---

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

• /src/src/openassetio-core/include/openassetio/managerApi/HostSession.hpp