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

Inheritance Hierarchy

References

   
Module ExternalRpcRegistry
Header /Engine/Source/Runtime/ExternalRPCRegistry/Public/ExternalRpcRegistry.h
Include #include "ExternalRpcRegistry.h"

Syntax

UCLASS (MinimalAPI)  
class UExternalRpcRegistry : public UObject

Remarks

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.

Variables

  Type Name Description
Protected variable TArray< FString > ActiveRpcCategories  
Public variable int PortToUse  
Protected variable TMap< FName, FExternalRouteDesc > RegisteredRoutes  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Clean up all routes - generally called as part of the destructor to make sure we don't have any function pointers dangling around.
Public function void

CleanUpRoute ( FName RouteName,
bool bFailIfUnbound
)

 Clean up a route. Can be set to fail if trying to unbind an unbound route.
Public function Static UExternalRpcRegistry *  
Public function bool

GetRegisteredRoute ( FName RouteName,
FExternalRouteInfo& OutRouteInfo
)

 Try to get a route registered under given friendly name. Returns false if could not be found.
Public function bool

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

 Default Route Listing http call.
Public function bool

IsActiveRpcCategory ( FString InCategory
)

 Check if this Rpc is from a category that is meant to be enabled.
Public function void

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

  
Public function 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.
Public function 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.

Constants

Name Description
ObjectInstance  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page