FRemoteSessionsManager

Object that is able to discover, issue and execute commands back and forth between the trace-based debuggers and client/server/editor instances

API > API/Runtime > API/Runtime/TraceBasedDebuggers

Object that is able to discover, issue and execute commands back and forth between the trace-based debuggers and client/server/editor instances

   
Name FRemoteSessionsManager
Type struct
Header File /Engine/Source/Runtime/Experimental/TraceBasedDebuggers/Public/RemoteSessionsManager.h
Include Path #include "RemoteSessionsManager.h"

Syntax

struct FRemoteSessionsManager : public TSharedFromThis< FRemoteSessionsManager >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FRemoteSessionsManager()

   RemoteSessionsManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FRemoteSessionsManager()

   RemoteSessionsManager.h  

Typedefs

Name Type Remarks Include Path
FMessagingInitialized TMulticastDelegate_TwoParams< void, TSharedPtr< IMessageBus > NewMessageBus, TSharedPtr< FMessageEndpoint > NewEndpoint >   RemoteSessionsManager.h
FVisitorFunction TFunction< void(const UScriptStruct *)>   RemoteSessionsManager.h

Constants

Name Type Remarks Include Path
AllRemoteClientsTargetName const FString   RemoteSessionsManager.h
AllRemoteClientsWrapperGUID const FGuid   RemoteSessionsManager.h
AllRemoteServersTargetName const FString   RemoteSessionsManager.h
AllRemoteServersWrapperGUID const FGuid   RemoteSessionsManager.h
AllRemoteSessionsTargetName const FString   RemoteSessionsManager.h
AllRemoteSessionsWrapperGUID const FGuid   RemoteSessionsManager.h
AllSessionsTargetName const FString   RemoteSessionsManager.h
AllSessionsWrapperGUID const FGuid   RemoteSessionsManager.h
CustomSessionsTargetName const FString   RemoteSessionsManager.h
CustomSessionsWrapperGUID const FGuid   RemoteSessionsManager.h
InvalidSessionGUID const FGuid   RemoteSessionsManager.h
LocalEditorSessionID const FGuid   RemoteSessionsManager.h
LocalEditorSessionName const FString   RemoteSessionsManager.h
MessageBusEndpointName const FName   RemoteSessionsManager.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveDebuggersUsingSessionDiscovery TArray< FGuid >   RemoteSessionsManager.h  
ActiveSessionsById TMap< FGuid, TSharedPtr< FSessionInfo > >   RemoteSessionsManager.h  
bInitialized bool   RemoteSessionsManager.h  
CustomMessageBridge TSharedPtr< IMessageBridge >   RemoteSessionsManager.h  
Handlers TArray< TSharedRef< IRemoteSessionsHandler > >   RemoteSessionsManager.h  
LastPingTime FDateTime Holds the time at which the last ping was sent. RemoteSessionsManager.h  
MessageBusPtr TWeakPtr< IMessageBus > Holds a pointer to the message bus. RemoteSessionsManager.h  
MessageEndpoint TSharedPtr< FMessageEndpoint > Holds the messaging endpoint. RemoteSessionsManager.h  
MessagingInitializedDelegate FMessagingInitialized   RemoteSessionsManager.h  
PendingRecordingConnectionDetailsMessages TMap< FGuid, FTraceConnectionDetails >   RemoteSessionsManager.h  
PendingRecordingStatusMessages TMap< FGuid, FRecordingStatusMessage >   RemoteSessionsManager.h  
RecordingStartedDelegate FRecordingStateChangeDelegate   RemoteSessionsManager.h  
RecordingStoppedDelegate FRecordingStateChangeDelegate   RemoteSessionsManager.h  
SessionDiscoveredDelegate FSessionLifetimeDelegate   RemoteSessionsManager.h  
SessionExpiredDelegate FSessionLifetimeDelegate   RemoteSessionsManager.h  
SessionsUpdatedDelegate FSimpleMulticastDelegate   RemoteSessionsManager.h  
SupportedMessageTypes TArray< const UScriptStruct * >   RemoteSessionsManager.h  
SupportedMessageTypesChangedDelegate FOnSupportedMessageTypesChanged   RemoteSessionsManager.h  
TickHandle FTSTicker::FDelegateHandle   RemoteSessionsManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanPublishToNetwork ( const FTopLevelAssetPath& MessageType
) const

 Returns true if this instance can publish messages to remote endpoints via a network bridge. RemoteSessionsManager.h  
Templated convenience wrapper for CanPublishToNetwork. RemoteSessionsManager.h  

void EnumerateActiveSessions ( const CallbackType& Callback
)

 Iterates through all active and valid sessions, and executes the provided callback to it. RemoteSessionsManager.h  

void EnumerateMessageTypes ( const FVisitorFunction& InVisitor
)

 Enumerate messages types allowed by this module. RemoteSessionsManager.h  

TWeakPtr< FSessionInfo > GetFirstAvailableSingleSessionInfo()

 Returns the first available session info RemoteSessionsManager.h  

TWeakPtr< FMessageEndpoint > GetMessageBusEndPoint()

   RemoteSessionsManager.h  

TWeakPtr< IMessageBus > GetMessageBusInstance()

   RemoteSessionsManager.h  

TWeakPtr< FSessionInfo > GetSessionInfo ( FGuid Id
)

 Returns the session info object for the provided ID RemoteSessionsManager.h  

FMessagingInitialized & OnMessagingInitialized()

   RemoteSessionsManager.h  

FSessionLifetimeDelegate & OnSessionDiscovered()

   RemoteSessionsManager.h  

FSessionLifetimeDelegate & OnSessionExpired()

   RemoteSessionsManager.h  

FRecordingStateChangeDelegate & OnSessionRecordingStarted()

 Delegate that broadcast when a recording was started in a session (either local or remote) RemoteSessionsManager.h  

FRecordingStateChangeDelegate & OnSessionRecordingStopped()

 Delegate that broadcast when a recording stops in a session (either local or remote) RemoteSessionsManager.h  

FSimpleMulticastDelegate & OnSessionsUpdated()

   RemoteSessionsManager.h  

FOnSupportedMessageTypesChanged & OnSupportedMessageTypesChanged ()

 Delegate broadcast whenever the supported message types list changes. RemoteSessionsManager.h  

void PublishMessage ( const T& InMessage
)

 Broadcast to the network a given message RemoteSessionsManager.h  

void RegisterExternalHandler ( TSharedRef< IRemoteSessionsHandler > Handler
)

   RemoteSessionsManager.h  
Adds a message type to the list of supported message types for this session system. RemoteSessionsManager.h  
Adds a message type to the list of supported message types for this session system. RemoteSessionsManager.h  

void ReInitializeMessagingSystem ( const TSharedPtr< IMessageBus >& InMessageBus
)

   RemoteSessionsManager.h  

void SendCommand ( const FMessageAddress& InDestinationAddress,
const T& InMessage
)

 Issues a command to the provided address to change the state of a data channel RemoteSessionsManager.h  

void SetMessageBridge ( const TSharedPtr< IMessageBridge >& InMessageBridge
)

 Sets an external message bridge for per-type reachability checks. RemoteSessionsManager.h  
  RemoteSessionsManager.h  

void StartSessionDiscovery ( const FGuid& InDebuggerGuid
)

 Starts sending ping requests that potential targets (client, servers or other editors) can answer to and report themselves as available RemoteSessionsManager.h  
  RemoteSessionsManager.h  

void StopSessionDiscovery ( const FGuid& InDebuggerGuid
)

 Stop sending ping requests to potential targets (client, servers or other editors). RemoteSessionsManager.h  

void UnregisterExternalHandler ( TSharedRef< IRemoteSessionsHandler > Handler
)

   RemoteSessionsManager.h  

Public Virtual

Static

Name Remarks Include Path Unreal Specifiers

static bool IsController()

 Returns true if this instance has controller capabilities (is either an editor or standalone application, which is also an editor) RemoteSessionsManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page