IBackChannelPacket

Declares the interface for a BackChannel packet

Windows
MacOS
Linux

References

Module

BackChannel

Header

/Engine/Plugins/Experimental/BackChannel/Source/BackChannel/Public/BackChannel/IBackChannelPacket.h

Include

#include "BackChannel/IBackChannelPacket.h"

Syntax

class IBackChannelPacket

Remarks

Declares the interface for a BackChannel packet

Destructors

Name Description

Public function Virtual

~IBackChannelPacket()

Functions

Name Description

Public function Const

FString

 

GetPath()

Return the path of this packet (if supported)

Public function Const

FBackChannel ...

 

GetProtocolID()

Public function Const

FString

 

GetProtocolName()

Public function Const

bool

 

IsReadable()

Public function Const

bool

 

IsWritable()

Public function

int

 

Read

(
    const TCHAR * InName,
    void * OutBlob,
    int32 MaxBlobSize,
    int32 & OutBlobSize
)

Read a block of data from the message

Public function

int

 

Read

(
    const TCHAR * Name,
    TArray < uint8 >& Data
)

Read a TArray from the message

Public function

int

 

Read

(
    const TCHAR * Name,
    FString & Value
)

Read a string from the message

Public function

int

 

Read

(
    const TCHAR * Name,
    bool & Value
)

Read a bool from the message

Public function

int

 

Read

(
    const TCHAR * Name,
    float& Value
)

Read an int32 from the message

Public function

int

 

Read

(
    const TCHAR * Name,
    int32 & Value
)

Read an int32 from the message

Public function

int

 

SetPath

(
    const TCHAR * InPath
)

Set the path of this packet (if supported)

Public function

int

 

Write

(
    const TCHAR * Name,
    const int32 Value
)

Write an int32 into the message

Public function

int

 

Write

(
    const TCHAR * Name,
    const float Value
)

Write an int32 into message

Public function

int

 

Write

(
    const TCHAR * Name,
    const bool Value
)

Write a bool into the message

Public function

int

 

Write

(
    const TCHAR * Name,
    const TCHAR * Value
)

Write a string into the message

Public function

int

 

Write

(
    const TCHAR * Name,
    const FString & Value
)

Write a string into the message

Public function

int

 

Write

(
    const TCHAR * Name,
    const TArrayView < const uint8 > Val...
)

Write a TArray into the message

Public function

int

 

Write

(
    const TCHAR * Name,
    const void * InBlob,
    int32 BlobSize
)

Write a block of data into the message
Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback