Navigation
API > API/Plugins > API/Plugins/OnlineSubsystemUtils > API/Plugins/OnlineSubsystemUtils/UIpNetDriver
Runnable object representing the receive thread, if enabled.
| Name | FReceiveThreadRunnable |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Classes/IpNetDriver.h |
| Include Path | #include "IpNetDriver.h" |
Syntax
class FReceiveThreadRunnable : public FRunnable
Inheritance Hierarchy
- FRunnable → UIpNetDriver::FReceiveThreadRunnable
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FReceiveThreadRunnable
(
UIpNetDriver* InOwningNetDriver |
IpNetDriver.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsRunning | TAtomic< bool > | Running flag. The Run() function will return shortly after setting this to false. | IpNetDriver.h | |
| ReceiveQueue | TCircularQueue< FReceivedPacket > | Thread-safe queue of received packets. | IpNetDriver.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CommandQueue | TSpscQueue< TUniqueFunction< void()> > | Command queue from Game Thread to Receive Thread | IpNetDriver.h | |
| OwnerEventQueue | TSpscQueue< TUniqueFunction< void()> > | Event queue from the Receive Thread to the Game Thread (may be generalized to 'Owning' thread in future) | IpNetDriver.h | |
| OwningNetDriver | UIpNetDriver * | The NetDriver which owns the receive thread | IpNetDriver.h | |
| Socket | TSharedPtr< FSocket > | Shared pointer for the socket, owned by the Game Thread | IpNetDriver.h | |
| SocketSubsystem | ISocketSubsystem * | The socket subsystem used by the receive thread | IpNetDriver.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void PumpOwnerEventQueue() |
Execute commands in OwnerEventQueue on the Game Thread | IpNetDriver.h | |
virtual uint32 Run() |
IpNetDriver.h | ||
void SetSocket
(
const TSharedPtr< FSocket >& InGameThreadSocket, |
Sets the socket for the Receive Thread, and triggers a callback (if specified) on the Game Thread when this is complete. | IpNetDriver.h |