FSessionService Class Reference

#include <SessionService.h>

Inheritance diagram for FSessionService:

Public Member Functions
	FSessionService (const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &InMessageBus)
virtual	~FSessionService ()
virtual void	Serialize (const TCHAR *Data, ELogVerbosity::Type Verbosity, const class FName &Category) override
virtual bool	IsRunning () override
virtual bool	Start () override
virtual void	Stop () override
Public Member Functions inherited from FOutputDevice
CORE_API	FOutputDevice ()
CORE_API	FOutputDevice (FOutputDevice &&)
CORE_API	FOutputDevice (const FOutputDevice &)
CORE_API FOutputDevice &	operator= (FOutputDevice &&)
CORE_API FOutputDevice &	operator= (const FOutputDevice &)
virtual CORE_API	~FOutputDevice ()
virtual void	Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category)=0
virtual void	Serialize (const TCHAR *V, ELogVerbosity::Type Verbosity, const FName &Category, const double Time)
virtual CORE_API void	SerializeRecord (const UE::FLogRecord &Record)
virtual void	Flush ()
virtual void	TearDown ()
void	SetSuppressEventTag (bool bInSuppressEventTag)
UE_FORCEINLINE_HINT bool	GetSuppressEventTag () const
void	SetAutoEmitLineTerminator (bool bInAutoEmitLineTerminator)
UE_FORCEINLINE_HINT bool	GetAutoEmitLineTerminator () const
virtual void	Dump (class FArchive &Ar)
virtual bool	IsMemoryOnly () const
virtual bool	CanBeUsedOnAnyThread () const
virtual bool	CanBeUsedOnMultipleThreads () const
virtual bool	CanBeUsedOnPanicThread () const
CORE_API void	Log (const TCHAR *S)
CORE_API void	Log (ELogVerbosity::Type Verbosity, const TCHAR *S)
CORE_API void	Log (const FName &Category, ELogVerbosity::Type Verbosity, const TCHAR *Str)
CORE_API void	Log (const FString &S)
CORE_API void	Log (const FText &S)
CORE_API void	Log (ELogVerbosity::Type Verbosity, const FString &S)
CORE_API void	Log (const FName &Category, ELogVerbosity::Type Verbosity, const FString &S)
template<typename FmtType >
void	Logf (const FmtType &Fmt)
template<typename FmtType , typename... Types>
void	Logf (const FmtType &Fmt, Types... Args)
template<typename FmtType , typename... Types>
void	Logf (ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
template<typename FmtType , typename... Types>
void	CategorizedLogf (const FName &Category, ELogVerbosity::Type Verbosity, const FmtType &Fmt, Types... Args)
Public Member Functions inherited from ISessionService
virtual	~ISessionService ()

Protected Member Functions
void	SendLog (const TCHAR *Data, ELogVerbosity::Type Verbosity=ELogVerbosity::Log, const class FName &Category="Log")
void	SendNotification (const TCHAR *NotificationText, const FMessageAddress &Recipient)
void	SendPong (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context, const FString &UserName)

Additional Inherited Members
Protected Attributes inherited from FOutputDevice
bool	bSuppressEventTag
bool	bAutoEmitLineTerminator

Detailed Description

Implements an application session service.

Constructor & Destructor Documentation

FSessionService()

FSessionService::FSessionService

(

const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &

InMessageBus

)

Creates and initializes a new instance.

Parameters

InMessageBus

The message bus to use.

~FSessionService()

FSessionService::~FSessionService ( )

virtual

Virtual destructor.

Member Function Documentation

IsRunning()

virtual bool FSessionService::IsRunning ( )

inlineoverridevirtual

Checks whether the service is running.

Returns

true if the service is running, false otherwise.

See also

Start, Stop

Implements ISessionService.

SendLog()

void FSessionService::SendLog ( const TCHAR *  Data, ELogVerbosity::Type  Verbosity = ELogVerbosity::Log, const class FName &  Category = "Log"  )

protected

Sends a log message to subscribed recipients.

Parameters

Data	The log message data.
Verbosity	The verbosity type.
Category	The log category.

SendNotification()

void FSessionService::SendNotification ( const TCHAR *  NotificationText, const FMessageAddress &  Recipient  )

protected

Sends a notification to the specified recipient.

Parameters

NotificationText	The notification text.
Recipient	The recipient's message address.

SendPong()

void FSessionService::SendPong ( const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &  Context, const FString &  UserName  )

protected

Publishes a ping response.

Parameters

Context	The context of the received Ping message.
UserName	The name of the user that sent the ping.

Serialize()

virtual void FSessionService::Serialize ( const TCHAR *  Data, ELogVerbosity::Type  Verbosity, const class FName &  Category  )

inlineoverridevirtual

Start()

bool FSessionService::Start ( )

overridevirtual

Starts the service.

Returns

true if the service was started, false otherwise.

See also

IsRunning, Stop

Implements ISessionService.

Stop()

void FSessionService::Stop ( )

overridevirtual

Stops the service.

See also

IsRunning, Start

Implements ISessionService.

---

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

• Engine/Source/Runtime/SessionServices/Private/SessionService.h
• Engine/Source/Runtime/SessionServices/Private/SessionService.cpp