SessionServiceFetch Class Reference

#include "steam/mobject/session/session-service-fetch.hpp"

Description

Implementation-level service for resolving an Placement-ID.

Usually, this service is backed by the PlacementIndex of the current session – however, for the purpose of unit testing, this index may be overlaid temporarily, by using the SessionServiceMockIndex API.

Definition at line 62 of file session-service-fetch.hpp.

Static Public Member Functions
static bool	isAccessible ()
	is the element-fetch service usable? Effectively this means: is the session up?
static bool	isRegisteredID (PlacementMO::ID const &)
	verify the given placement-ID (hash) is valid, by checking if it refers to a Placement instance currently registered with the PlacementIndex of the active Session. More...
static PlacementMO &	resolveID (PlacementMO::ID const &)
	actually retrieve a Placement tracked by the index. More...

Member Function Documentation

resolveID()

PlacementMO & resolveID ( PlacementMO::ID const &  placementID )

static

actually retrieve a Placement tracked by the index.

Parameters

placementID

hash-ID, typically from a PlacementRef

Exceptions

error::Invalid

if the ID isn't resolvable

Note

the returned ref is guaranteed to be valid and usable only now, which means, by virtue of the SteamDispatcher and command processing, during this operation. It can be used to invoke an operation, but should never be stored; rather, client code should create an MObjectRef, if bound to store an reference for later.

Definition at line 95 of file session-services.cpp.

isRegisteredID()

bool isRegisteredID ( PlacementMO::ID const &  placementID )

static

verify the given placement-ID (hash) is valid, by checking if it refers to a Placement instance currently registered with the PlacementIndex of the active Session.

Definition at line 78 of file session-services.cpp.

Referenced by PlacementRef< MObject >::operator->().

Here is the caller graph for this function:

Collaboration diagram for SessionServiceFetch:

---

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

• session-service-fetch.hpp
• session-services.cpp