Steve Pham
38261d0800
* Updated all copyright headers to split the longer original copyright line into 2 shorter lines Signed-off-by: Steve Pham <spham@amazon.com>
108 lines
3.3 KiB
C++
108 lines
3.3 KiB
C++
/*
|
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
*
|
|
*/
|
|
#ifndef GRID_MATE_H
|
|
#define GRID_MATE_H 1
|
|
|
|
#include <GridMate/Carrier/Carrier.h>
|
|
#include <GridMate/Types.h>
|
|
|
|
/// \file gridmate.h
|
|
|
|
namespace GridMate
|
|
{
|
|
/**
|
|
* GridMate creation descriptor.
|
|
*/
|
|
struct GridMateDesc
|
|
{
|
|
GridMateDesc()
|
|
: m_allocatorDesc()
|
|
, m_endianType(EndianType::BigEndian) { }
|
|
|
|
/**
|
|
* GridMate default allocator. It will be used for all basic services and online module.
|
|
*/
|
|
GridMateAllocator::Descriptor m_allocatorDesc;
|
|
|
|
/**
|
|
* Endianness serialized to the network.
|
|
*/
|
|
EndianType m_endianType;
|
|
};
|
|
|
|
class GridMateService;
|
|
class SessionService;
|
|
struct SessionServiceDesc;
|
|
struct SessionParams;
|
|
struct JoinParams;
|
|
struct SearchParams;
|
|
struct SearchInfo;
|
|
struct InviteInfo;
|
|
struct SessionIdInfo;
|
|
class GridSession;
|
|
class GridSearch;
|
|
|
|
/**
|
|
* GridMate interface.
|
|
*/
|
|
class IGridMate
|
|
{
|
|
public:
|
|
virtual ~IGridMate() { }
|
|
virtual void Update() = 0;
|
|
|
|
virtual EndianType GetDefaultEndianType() const = 0;
|
|
|
|
// Binds service to GridMate instance, GridMate owns session pointer after that and responsible for releasing it,
|
|
// if delegateOwnership flag is set -> GridMate will take ownership over service instance and will be soleily responsible for it's deletion
|
|
virtual void RegisterService(GridMateServiceId id, GridMateService* service, bool delegateOwnership = false) = 0;
|
|
|
|
// Unbinds service from GridMate instance, service should not be used after this is called
|
|
virtual void UnregisterService(GridMateServiceId id) = 0;
|
|
|
|
// Returns true if a service with the specified service id is currently registered with this GridMate
|
|
virtual bool HasService(GridMateServiceId id) = 0;
|
|
|
|
// Returns the service registered with the specified service id, or nullptr if not found.
|
|
virtual GridMateService* GetServiceById(GridMateServiceId id) = 0;
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
* Helper function to start service of given type and register it with GridMate.
|
|
* Newly created service instance will be owned by GridMate.
|
|
*/
|
|
template<class ServiceType, class ... Args>
|
|
ServiceType* StartGridMateService(IGridMate* gridMate, Args&& ... args)
|
|
{
|
|
ServiceType* service = aznew ServiceType(AZStd::forward<Args>(args) ...);
|
|
gridMate->RegisterService(ServiceType::GetGridMateServiceId(),service, true);
|
|
return service;
|
|
}
|
|
|
|
template<class ServiceType>
|
|
void StopGridMateService(IGridMate* gridMate)
|
|
{
|
|
gridMate->UnregisterService(ServiceType::GetGridMateServiceId());
|
|
}
|
|
|
|
template<class ServiceType>
|
|
bool HasGridMateService(IGridMate* gridMate)
|
|
{
|
|
return gridMate->HasService(ServiceType::GetGridMateServiceId());
|
|
}
|
|
|
|
/// Create GridMate interface object. You are allowed to have only one active at a time. \todo use shared_ptr or intrusive_ptr
|
|
IGridMate* GridMateCreate(const GridMateDesc& desc);
|
|
/// Destroys and frees all GridMate resources.
|
|
void GridMateDestroy(IGridMate* gridMate);
|
|
}
|
|
|
|
#endif // GRID_MATE_H
|