IConcertLocalEndpoint

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

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public function Virtual

~IConcertLocalEndpoint()

Virtual destructor

Functions

Name Description

Public function Const

const FConce...

 

GetEndpointContext()

Get the context for this endpoint.

Protected function

void

 

InternalAddEventHandler

(
    const FName& EventMessageType,
    const TSharedRef< IConcertEventHand...
)

Add an Event Handler

Protected function

void

 

InternalAddRequestHandler

(
    const FName& RequestMessageType,
    const TSharedRef< IConcertRequestHa...
)

Add a Request Handler

Protected function

void

 

InternalPublishEvent

(
    const TSharedRef< IConcertEvent >&...
)

Publish an event to any listening endpoints

Protected function

void

 

InternalQueueEvent

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

Queue an event to be sent to a remote endpoint

Protected function

void

 

InternalQueueRequest

(
    const TSharedRef< IConcertRequest >...,
    const FGuid& Endpoint
)

Queue a request to be sent to a remote endpoint

Protected function

void

 

InternalQueueResponse

(
    const TSharedRef< IConcertResponse ...,
    const FGuid& Endpoint
)

Queue a response to be sent back to a remote endpoint

Protected function

void

 

InternalRemoveEventHandler

(
    const FName& EventMessageType
)

Remove an Event Handler

Protected function

void

 

InternalRemoveRequestHandler

(
    const FName& RequestMessageType
)

Remove an Request Handler

Protected function

void

 

InternalSubscribeToEvent

(
    const FName& EventMessageType
)

Subscribe to an Event

Protected function

void

 

InternalUnsubscribeFromEvent

(
    const FName& EventMessageType
)

Unsubscribe from an Event

Public function

FOnConcertRe...

 

OnRemoteEndpointConnectionChanged()

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

(
    typename TConcertFunctionEventHandl...
)

Register an handler for event received by this endpoint

Public function

void

 

RegisterEventHandler

(
    HandlerType* Handler,
    typename TConcertRawEventHandler< H...
)

Register an handler for event received by this endpoint

Public function

void

 

RegisterRequestHandler

(
    typename TConcertFunctionRequestHan...
)

Register an handler for request received by this endpoint

Public function

void

 

RegisterRequestHandler

(
    HandlerType* Handler,
    typename TConcertRawRequestHandler<...
)

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< Res...

 

SendRequest

(
    const RequestType& Request,
    const FGuid& Endpoint
)

Send a request to a remote endpoint

Protected function

void

 

SetMessageSendingInfo

(
    const TSharedRef< IConcertMessage >...
)

Set message ID and sender ID

Protected function

void

 

SetResponseSendingInfo

(
    const TSharedRef< IConcertResponse ...,
    const FGuid& RequestMessageId
)

Set message ID and sender ID

Public function

void

 

SubscribeEventHandler

(
    HandlerType* Handler,
    typename TConcertRawEventHandler< H...
)

Subscribe an handler for event received by this endpoint, this will handle published event

Public function

void

 

UnregisterEventHandler()

Unregister the handler for event received by this endpoint of type EventType

Public function

void

 

UnregisterRequestHandler()

Unregister the handler for request received by this endpoint of type RequestType

Public function

void

 

UnsubscribeEventHandler()

Unregister the handler for event received by this endpoint of type EventType