1. Epic GamesDeveloper
  3. UExternalRpcRegistrationComponent

UExternalRpcRegistrationComponent

API > API/Runtime > API/Runtime/ExternalRpcRegistry

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

Syntax

UCLASS (MinimalAPI)  
class UExternalRpcRegistrationComponent : public UObject

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ListenerAddress FString   ExternalRpcRegistrationComponent.h  
RegisteredRoutes TArray< FName >   ExternalRpcRegistrationComponent.h  
SecuritySecret FString   ExternalRpcRegistrationComponent.h  
SenderID FString Outgoing RPC info. ExternalRpcRegistrationComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BroadcastRpcListChanged()

 Function called when RPCs are registered or deregistered to notify any listeners that they need to refresh their RPC list. ExternalRpcRegistrationComponent.h  

FHttpRequestHandler CreateRouteHandle ( TDelegate< bool(const FHttpServerRequest&Request, const FHttpResultCallback&OnComplete)> InFunc
)

 Creates an Http Request Handler that gets routed through the additional handling of the ExternalRpcRegistry ExternalRpcRegistrationComponent.h  

TUniquePtr< FHttpServerResponse > CreateSimpleResponse ( bool bInWasSuccessful,
FString InValue,
bool bInFatal
)

 Generates a simple Json response object with success and reason for use when returning a response. ExternalRpcRegistrationComponent.h  

virtual void DeregisterHttpCallbacks()

 Deregisters and cleans up all routes managed by this component. ExternalRpcRegistrationComponent.h  

bool HttpSendMessageToListener ( FString MessageCategory,
FString MessagePayload
)

 Send a message to all listeners with a custom category and payload for consumption by external processes. ExternalRpcRegistrationComponent.h  

bool HttpUpdateIpOnListener ( FString TargetName,
FString MessagePayload
)

 Send a message to all listeners describing the game IP of the current process. ExternalRpcRegistrationComponent.h  

virtual void RegisterAlwaysOnHttpCallbacks()

 Registration function for RPCs that should always be enabled as long as this Registration Component is active. ExternalRpcRegistrationComponent.h  

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

 Hooks up a given delegate to the assigned route for external access. ExternalRpcRegistrationComponent.h  

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

 Hooks up a given delegate to the assigned route for external access. ExternalRpcRegistrationComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page