1. Epic GamesDeveloper
  3. FEndpoint

FEndpoint

[FEndpoint](API\Runtime\DirectLink\FEndpoint) class is the main interface for sending and receiving data with the DirectLink system.

Unreal Engine C++ API Reference > Runtime > DirectLink

Inheritance Hierarchy

References

   
Module DirectLink
Header /Engine/Source/Runtime/Datasmith/DirectLink/Public/DirectLinkEndpoint.h
Include #include "DirectLinkEndpoint.h"

Syntax

class FEndpoint : public FNoncopyable

Remarks

FEndpoint class is the main interface for sending and receiving data with the DirectLink system.

Instances of this class discover themselves (through MessageBus) and can see Sources and Destinations available on each others. This is automatic and works for multiple applications. With that system, one can expose data from an application and consume it from another.

An endpoint can exposes N sources and N Destinations. That being said, a more classic setup is to have an 'exporter' process that only exposes sources, and some 'consumer' process that only have Destinations.

As a convention, 'consumers' have the responsibility to handle the connections management. Exporters have the sole responsibility to exposes their data.

Setup example:

  • Exporter process
  • Source "My First Source"
  • Source "My Second Source"
  • Consumer process
  • Destination "Viewport"

The consumer process can handle the connections between Sources and Destinations with the OpenStream and CloseStream methods.

Constructors

  Type Name Description
Public function  

FEndpoint ( const FString& InName
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function FDestinationHandle

AddDestination ( const FString& Name,
EVisibility Visibility,
const TSharedPtr< class IConnectionRequestHandler >& ConnectionRequestHandler
)

 Add a Destination on that endpoint
Public function void Register an IEndpointObserver that will be notified periodically with the last state of the swarm.
Public function FSourceHandle

AddSource ( const FString& Name,
EVisibility Visibility
)

 Add a Source to that endpoint.
Public function void

CloseStream ( const FSourceHandle& SourceId,
const FDestinationHandle& DestinationId
)

 Close a previously opened stream
Public function Const FRawInfo Get a snapshot of the current state of the DirectLink swarm.
Public function EOpenStreamResult

OpenStream ( const FSourceHandle& SourceId,
const FDestinationHandle& DestinationId
)

 Open a Stream between a Source and a Destination
Public function void

RemoveDestination ( const FDestinationHandle& Destination
)

 Disconnect all streams related to that destination and removes the Destination itself from that endpoint
Public function void Removes a previously added observer
Public function void

RemoveSource ( const FSourceHandle& Source
)

 Closes all streams related to this Source and remove it from the endpoint.
Public function void

SetSourceRoot ( const FSourceHandle& Source,
ISceneGraphNode* InRoot,
bool bSnapshot
)

 Set the root of the content that should be exposed from that source.
Public function void

SetVerbose ( bool bVerbose
)

  
Public function void

SnapshotSource ( const FSourceHandle& Source
)

 Use the Source root to discover the graph and snapshot the content in its current state.

Enums

  Type Name Description
Public enum EOpenStreamResult    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page