1. Epic GamesDeveloper
  3. UStormSyncNotificationSubsystem

UStormSyncNotificationSubsystem

This subsystem main purpose is to listen for tcp related events triggered from StormSyncTransport layers and module, to provide in-editor integration and handle UI/UX feedback to the end user.

API > API/Plugins > API/Plugins/StormSyncEditor > API/Plugins/StormSyncEditor/Subsystems

Inheritance Hierarchy

References

   
Module StormSyncEditor
Header /Engine/Plugins/Experimental/StormSync/Source/StormSyncEditor/Public/Subsystems/StormSyncNotificationSubsystem.h
Include #include "Subsystems/StormSyncNotificationSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class UStormSyncNotificationSubsystem : public UEditorSubsystem

Remarks

This subsystem main purpose is to listen for tcp related events triggered from StormSyncTransport layers and module, to provide in-editor integration and handle UI/UX feedback to the end user.

Variables

  Type Name Description
Protected variable TMap< FString, FStormSyncNotificationTask > Notifications Currently active notifications. Key is the remote address.

Functions

  Type Name Description
Protected function Virtual void

AddProgressBarNotification ( const FString& InRemoteAddress,
const FString& InRemoteHostName
)

 Called on OnPreStartSendingBuffer(), creates and display a new notification widget, displaying current status of buffer upload.
Public function TSharedPtr< SNotificationItem >

AddSimpleNotification ( const FText& InNotificationText
)

  
Public function TSharedPtr< SNotificationItem >  
Protected function Virtual void  
Public function void

Error ( const FText& InMessageLogText
)

  
Public function Static UStormSyncNotificationSubsystem &

Get ()

 Static convenience method to return storm sync notification subsystem
Public function void  
Public function void  
Public function void

HandleSyncResponse ( const TSharedPtr< FStormSyncTransportSyncResponse >& InResponse,
const FText& InSuccessTextFormat,
const FText& InErrorTextFormat
)

  
Public function void

Info ( const FText& InMessageLogText
)

  
Protected function Virtual void

Initialize ( FSubsystemCollectionBase& InCollection
)

  
Public function void

NewPage ( const FText& InLabel,
const bool bInAppendDateTime
)

  
Public function void

Notify ( const EMessageSeverity::Type InSeverity,
const FText& InMessageLogText,
const bool bInForce
)

  
Protected function Virtual void

OnDismissButtonClicked ( const FString InRemoteAddress
)

 Dismiss button click handler
Protected function void

OnPreStartSendingBuffer ( const FString& InRemoteAddress,
const FString& InRemoteHostname,
int32 InFileCount
)

 Callback handler for FStormSyncCoreDelegates::OnPreStartSendingBuffer delegate
Protected function void

OnReceivingBytes ( const FString& InRemoteAddress,
int32 InBytesCount
)

 Callback handler for FStormSyncCoreDelegates::OnPreStartSendingBuffer delegate
Protected function void

OnStartSendingBuffer ( const FString& InRemoteAddress,
int32 InBufferSize
)

 Callback handler for FStormSyncCoreDelegates::OnStartSendingBuffer delegate
Protected function Virtual void

UpdateProgressBarNotificationOnIncomingBytes ( const FString& InRemoteAddress,
const int32 InReceivedBytes
)

 Called from OnReceivingBytes() and updates notification widget with received bytes count
Protected function Virtual void

UpdateProgressBarNotificationOnStart ( const FString& InRemoteAddress,
const int32 InBufferSize
)

 Called from OnStartSendingBuffer() right before sending the stream.
Public function void

Warning ( const FText& InMessageLogText
)

  

Constants

Name Description
LogName The name of the message output log we will send messages to

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page