1. Epic GamesDeveloper
  3. UExternalRpcRegistry

UExternalRpcRegistry

This class is designed to be a singleton that handles registry, maintenance, and cleanup of any REST endpoints exposed on the process for use in communicating with the process externally.

API > API/Runtime > API/Runtime/ExternalRpcRegistry

This class is designed to be a singleton that handles registry, maintenance, and cleanup of any REST endpoints exposed on the process for use in communicating with the process externally.

   
Name UExternalRpcRegistry
Type class
Header File /Engine/Source/Runtime/ExternalRPCRegistry/Public/ExternalRpcRegistry.h
Include Path #include "ExternalRpcRegistry.h"

Syntax

UCLASS (MinimalAPI)  
class UExternalRpcRegistry : public UObject

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

~UExternalRpcRegistry()

   ExternalRpcRegistry.h  

Constants

Name Type Remarks Include Path
ObjectInstance UExternalRpcRegistry *   ExternalRpcRegistry.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
PortToUse int   ExternalRpcRegistry.h  
RequestLedgerCapacity int   ExternalRpcRegistry.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddRequestToLedger ( const FHttpServerRequest& Request
)

 Records an RPC call into the ledger, plus trims the ledger if it is too large. ExternalRpcRegistry.h  

void CleanUpAllRoutes()

 Clean up all routes - generally called as part of the destructor to make sure we don't have any function pointers dangling around. ExternalRpcRegistry.h  

void CleanUpRoute ( FName RouteName,
bool bFailIfUnbound
)

 Clean up a route. Can be set to fail if trying to unbind an unbound route. ExternalRpcRegistry.h  

bool GetRegisteredRoute ( FName RouteName,
FExternalRouteInfo& OutRouteInfo
)

 Try to get a route registered under given friendly name. Returns false if could not be found. ExternalRpcRegistry.h  

bool HttpListOASv3JSONRoutes ( const FHttpServerRequest& Request,
const FHttpResultCallback& OnComplete
)

 Route Listing http, formatted for Swagger OASv3. ExternalRpcRegistry.h  

bool HttpListOpenRoutes ( const FHttpServerRequest& Request,
const FHttpResultCallback& OnComplete
)

 Default Route Listing http call. ExternalRpcRegistry.h  

bool HttpPrintRequestLedger ( const FHttpServerRequest& Request,
const FHttpResultCallback& OnComplete
)

 Default request history call. ExternalRpcRegistry.h  

bool HttpSwaggerUI ( const FHttpServerRequest& Request,
const FHttpResultCallback& OnComplete
)

 Route Showing SwaggerUI using /swagger.json to describe the current REST API. ExternalRpcRegistry.h  

bool IsActiveRpcCategory ( FString InCategory
)

 Check if this Rpc is from a category that is meant to be enabled. ExternalRpcRegistry.h  

void RegisterNewRoute ( FExternalRouteInfo InRouteInfo,
const FHttpRequestHandler& Handler,
bool bOverrideIfBound
)

   ExternalRpcRegistry.h  

void RegisterNewRoute ( FName RouteName,
const FHttpPath& HttpPath,
const EHttpServerRequestVerbs& RequestVerbs,
const FHttpRequestHandler& Handler,
bool bOverrideIfBound,
bool bIsAlwaysOn,
FString OptionalCategory,
FString OptionalContentType,
FString OptionalExpectedFormat
)

 Deprecated way to register a new route. ExternalRpcRegistry.h  

void RegisterNewRouteWithArguments ( FName RouteName,
const FHttpPath& HttpPath,
const EHttpServerRequestVerbs& RequestVerbs,
const FHttpRequestHandler& Handler,
TArray< FExternalRpcArgumentDesc > InArguments,
bool bOverrideIfBound,
bool bIsAlwaysOn,
FString OptionalCategory,
FString OptionalContentType
)

 Register a new route. ExternalRpcRegistry.h  

Static

Name Remarks Include Path Unreal Specifiers

static UExternalRpcRegistry * GetInstance()

   ExternalRpcRegistry.h  

static bool IsEnabled()

   ExternalRpcRegistry.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page