Navigation
API > API/Plugins > API/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 | |
|---|---|---|---|
| Virtual destructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
| const FConcertEndpointContext & | Get the context for this endpoint. | ||
| FMessageAddress | GetRemoteAddress
(
const FGuid& ConcertEndpointId |
Gets the remote address of a client or the server. | |
| TArray< FConcertEndpointContext > | Gets all remote endpoints connected to this local endpoint. | ||
| void | InternalAddEventHandler
(
const FTopLevelAssetPath& EventMessageType, |
Add an Event Handler | |
| void | InternalAddRequestHandler
(
const FTopLevelAssetPath& RequestMessageType, |
Add a Request Handler | |
| void | InternalPublishEvent
(
const TSharedRef< IConcertEvent >& Event |
Publish an event to any listening endpoints | |
| void | InternalQueueEvent
(
const TSharedRef< IConcertEvent >& Event, |
Queue an event to be sent to a remote endpoint | |
| void | InternalQueueRequest
(
const TSharedRef< IConcertRequest >& Request, |
Queue a request to be sent to a remote endpoint | |
| void | InternalQueueResponse
(
const TSharedRef< IConcertResponse >& Response, |
Queue a response to be sent back to a remote endpoint | |
| void | InternalRemoveEventHandler
(
const FTopLevelAssetPath& EventMessageType |
Remove an Event Handler | |
| void | InternalRemoveRequestHandler
(
const FTopLevelAssetPath& RequestMessageType |
Remove an Request Handler | |
| void | InternalSubscribeToEvent
(
const FTopLevelAssetPath& EventMessageType |
Subscribe to an Event | |
| void | InternalUnsubscribeFromEvent
(
const FTopLevelAssetPath& EventMessageType |
Unsubscribe from an Event | |
| FOnConcertMessageAcknowledgementReceivedFromLocalEndpoint & | Callback when a message has been acknowledged by a remote endpoint | ||
| FOnConcertRemoteEndpointConnectionChanged & | Callback when a remote endpoint connection changes. | ||
| void |
PublishEvent
(
const EventType& Event |
Publish an event, other remote endpoint need to subscribe to the event to receive it | |
| void | RegisterEventHandler
(
HandlerType* Handler, |
Register an handler for event received by this endpoint | |
| void | RegisterEventHandler
(
typename TConcertFunctionEventHandler::FFuncType Func |
Register an handler for event received by this endpoint | |
| void | RegisterRequestHandler
(
HandlerType* Handler, |
Register an handler for request received by this endpoint | |
| void | RegisterRequestHandler
(
typename TConcertFunctionRequestHandler< ResponseType >::FFuncType Func |
Register an handler for request received by this endpoint | |
| void | Send an event to a remote endpoint | ||
| TFuture< ResponseType > | SendRequest
(
const RequestType& Request, |
Send a request to a remote endpoint | |
| void | SetMessageSendingInfo
(
const TSharedRef< IConcertMessage >& Message |
Set message ID and sender ID | |
| void | SetResponseSendingInfo
(
const TSharedRef< IConcertResponse >& Response, |
Set message ID and sender ID | |
| void | SubscribeEventHandler
(
HandlerType* Handler, |
Subscribe an handler for event received by this endpoint, this will handle published event | |
| void | Unregister the handler for event received by this endpoint of type EventType | ||
| void | Unregister the handler for request received by this endpoint of type RequestType | ||
| void | Unregister the handler for event received by this endpoint of type EventType |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| void | InternalAddEventHandler
(
const FName& EventMessageType, |
Types names are now represented by path names. Please use a version of this function that takes an FTopLevelAssetPath as MessageType. | |
| void | InternalAddRequestHandler
(
const FName& RequestMessageType, |
Types names are now represented by path names. Please use a version of this function that takes an FTopLevelAssetPath as MessageType. | |
| 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. | |
| 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. | |
| 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. | |
| 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. |