1. Epic GamesDeveloper
  3. IConcertLocalEndpoint

IConcertLocalEndpoint

Interface representing a local endpoint you can send from either reliably or not for Concert

Unreal Engine C++ API Reference > Plugins > ConcertTransport

References

   
Module ConcertTransport
Header /Engine/Plugins/Developer/Concert/ConcertMain/Source/ConcertTransport/Public/IConcertEndpoint.h
Include #include "IConcertEndpoint.h"

Syntax

class IConcertLocalEndpoint

Remarks

Interface representing a local endpoint you can send from either reliably or not for Concert

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function Const const FConcertEndpointContext & Get the context for this endpoint.
Public function Const FMessageAddress

GetRemoteAddress ( const FGuid& ConcertEndpointId
)

 Gets the remote address of a client or the server.
Public function Const TArray< FConcertEndpointContext > Gets all remote endpoints connected to this local endpoint.
Protected function void

InternalAddEventHandler ( const FTopLevelAssetPath& EventMessageType,
const TSharedRef< IConcertEventHandler >& Handler
)

 Add an Event Handler
Protected function void

InternalAddRequestHandler ( const FTopLevelAssetPath& RequestMessageType,
const TSharedRef< IConcertRequestHandler >& Handler
)

 Add a Request Handler
Protected function void Publish an event to any listening endpoints
Protected function void

InternalQueueEvent ( const TSharedRef< IConcertEvent >& Event,
const FGuid& Endpoint,
EConcertMessageFlags Flags
)

 Queue an event to be sent to a remote endpoint
Protected function void

InternalQueueRequest ( const TSharedRef< IConcertRequest >& Request,
const FGuid& Endpoint
)

 Queue a request to be sent to a remote endpoint
Protected function void

InternalQueueResponse ( const TSharedRef< IConcertResponse >& Response,
const FGuid& Endpoint
)

 Queue a response to be sent back to a remote endpoint
Protected function void

InternalRemoveEventHandler ( const FTopLevelAssetPath& EventMessageType
)

 Remove an Event Handler
Protected function void

InternalRemoveRequestHandler ( const FTopLevelAssetPath& RequestMessageType
)

 Remove an Request Handler
Protected function void

InternalSubscribeToEvent ( const FTopLevelAssetPath& EventMessageType
)

 Subscribe to an Event
Protected function void

InternalUnsubscribeFromEvent ( const FTopLevelAssetPath& EventMessageType
)

 Unsubscribe from an Event
Public function FOnConcertMessageAcknowledgementReceivedFromLocalEndpoint & Callback when a message has been acknowledged by a remote endpoint
Public function FOnConcertRemoteEndpointConnectionChanged & Callback when a remote endpoint connection changes.
Public function void
PublishEvent

( const EventType& Event
)

 Publish an event, other remote endpoint need to subscribe to the event to receive it
Public function void

RegisterEventHandler ( HandlerType* Handler,
typename TConcertRawEventHandler< HandlerType >::FFuncType Func
)

 Register an handler for event received by this endpoint
Public function void Register an handler for event received by this endpoint
Public function void

RegisterRequestHandler ( HandlerType* Handler,
typename TConcertRawRequestHandler< ResponseType, HandlerType >::FFuncType Func
)

 Register an handler for request received by this endpoint
Public function void

RegisterRequestHandler ( typename TConcertFunctionRequestHandler< ResponseType >::FFuncType Func
)

 Register an handler for request received by this endpoint
Public function void

SendEvent ( const EventType& Event,
const FGuid& Endpoint,
EConcertMessageFlags Flags,
TMap< FName, FString > Annotations
)

 Send an event to a remote endpoint
Public function TFuture< ResponseType >

SendRequest ( const RequestType& Request,
const FGuid& Endpoint
)

 Send a request to a remote endpoint
Protected function void Set message ID and sender ID
Protected function void

SetResponseSendingInfo ( const TSharedRef< IConcertResponse >& Response,
const FGuid& RequestMessageId
)

 Set message ID and sender ID
Public function void

SubscribeEventHandler ( HandlerType* Handler,
typename TConcertRawEventHandler< HandlerType >::FFuncType Func
)

 Subscribe an handler for event received by this endpoint, this will handle published event
Public function void Unregister the handler for event received by this endpoint of type EventType
Public function void Unregister the handler for request received by this endpoint of type RequestType
Public function void Unregister the handler for event received by this endpoint of type EventType

Deprecated Functions

  Type Name Description
Protected function Virtual void

InternalAddEventHandler ( const FName& EventMessageType,
const TSharedRef< IConcertEventHandler >& Handler
)

 Types names are now represented by path names. Please use a version of this function that takes an FTopLevelAssetPath as MessageType.
Protected function Virtual void

InternalAddRequestHandler ( const FName& RequestMessageType,
const TSharedRef< IConcertRequestHandler >& Handler
)

 Types names are now represented by path names. Please use a version of this function that takes an FTopLevelAssetPath as MessageType.
Protected function Virtual void

InternalRemoveEventHandler ( const FName& EventMessageType
)

 Types names are now represented by path names. Please use a version of this function that takes an FTopLevelAssetPath as MessageType.
Protected function Virtual void

InternalRemoveRequestHandler ( const FName& RequestMessageType
)

 Types names are now represented by path names. Please use a version of this function that takes an FTopLevelAssetPath as MessageType.
Protected function Virtual void

InternalSubscribeToEvent ( const FName& EventMessageType
)

 Types names are now represented by path names. Please use a version of this function that takes an FTopLevelAssetPath as MessageType.
Protected function Virtual void

InternalUnsubscribeFromEvent ( const FName& EventMessageType
)

 Types names are now represented by path names. Please use a version of this function that takes an FTopLevelAssetPath as MessageType.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page