Files
UnrealEngineUWP/Engine/Source/Developer/SessionServices/Public/Interfaces/ISessionService.h
Max Preussner 1da14464ec SessionServices: Documentation cleanup pass
[CL 2095362 by Max Preussner in Main branch]
2014-06-04 23:38:16 -04:00

51 lines
1.1 KiB
C++

// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
ISessionService.h: Declares the ISessionService interface.
=============================================================================*/
#pragma once
/** Type definition for shared pointers to instances of ISessionService. */
typedef TSharedPtr<class ISessionService> ISessionServicePtr;
/** Type definition for shared references to instances of ISessionService. */
typedef TSharedRef<class ISessionService> ISessionServiceRef;
/**
* Interface for application session services.
*/
class ISessionService
{
public:
/**
* Checks whether the service is running.
*
* @return true if the service is running, false otherwise.
*/
virtual bool IsRunning( ) = 0;
/**
* Starts the service.
*
* @return true if the service was started, false otherwise.
* @see Stop
*/
virtual bool Start( ) = 0;
/**
* Stops the service.
* @see Start
*/
virtual void Stop( ) = 0;
public:
/**
* Virtual destructor.
*/
virtual ~ISessionService( ) { }
};