1. Epic GamesDeveloper
  3. UExternalRpcRegistrationComponent

UExternalRpcRegistrationComponent

API > API/Runtime > API/Runtime/ExternalRpcRegistry

Inheritance Hierarchy

References

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

Syntax

UCLASS ()  
class UExternalRpcRegistrationComponent : public UObject

Variables

  Type Name Description
Public variable FString ListenerAddress  
Public variable TArray< FName > RegisteredRoutes  
Public variable FString SecuritySecret  
Public variable FString SenderID Outgoing RPC info.

Functions

  Type Name Description
Public function void Function called when RPCs are registered or deregistered to notify any listeners that they need to refresh their RPC list.
Public function 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
Public function TUniquePtr< FHttpServerResponse >

CreateSimpleResponse ( bool bInWasSuccessful,
FString InValue
)

 Generates a simple Json response object with success and reason for use when returning a response.
Public function Virtual void Deregisters and cleans up all routes managed by this component.
Public function bool

HttpSendMessageToListener ( FString MessageCategory,
FString MessagePayload
)

 Send a message to all listeners qith a custom category and payload for consumption by external processes.
Public function bool

HttpUpdateIpOnListener ( FString TargetName,
FString MessagePayload
)

 Send a message to all listeners describing the game IP of the current process.
Public function Virtual void Registration function for RPCs that should always be enabled as long as this Registration Component is active.
Public function void

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

 Hooks up a given delegate to the assigned route for external access.
Public function 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page