1. Epic GamesDeveloper
  3. HandlerComponent

HandlerComponent

This class appends or modifies incoming and outgoing packets on a connection

API > API/Runtime > API/Runtime/PacketHandler

Inheritance Hierarchy

References

   
Module PacketHandler
Header /Engine/Source/Runtime/PacketHandlers/PacketHandler/Public/PacketHandler.h
Include #include "PacketHandler.h"

Syntax

class HandlerComponent

Remarks

This class appends or modifies incoming and outgoing packets on a connection

Variables

  Type Name Description
Protected variable bool bRequiresHandshake Whether this handler has to perform a network handshake during initialization (requires waiting on other HandlerComponent's)
Protected variable bool bRequiresReliability Whether this handler depends upon the ReliabilityHandlerComponent being enabled
Public variable PacketHandler * Handler The manager of the handler, set in initialization
Protected variable uint32 MaxOutgoingBits Maximum number of Outgoing packet bits supported (automatically calculated to factor in other HandlerComponent reserved bits)
Protected variable UE::Handler::Component::State State The state of this handler

Constructors

  Type Name Description
Public function   Base constructorHandlerComponent
Public function  

HandlerComponent ( FName InName
)

 Constructor that accepts a name

Destructors

  Type Name Description
Public function Virtual   Base destructor

Functions

  Type Name Description
Public function Virtual Const bool Whether or not the Incoming/IncomingConnectionless implementations, support reading Packets that aren't aligned at bit position 0 (i.e. whether or not this handler supports bit-level, rather than byte-level, reads)
Public function Virtual Const void  
Public function Const FName

GetName ()

 Returns the name of this component.
Public function Const int32 Returns the amount of reserved packet/protocol bits expected from this component.
Public function Virtual void Handles incoming packets
Public function Virtual void Handles incoming packets not associated with a UNetConnection
Public function Virtual void Initializes a reference to the NetConnection fault recovery interface (does not require Engine dependency)
Public function void Initialization functionality should be placed here
Protected function void Should be called when the handler is fully initialized on both remote and local
Public function Virtual Const bool Returns whether this handler is currently active
Public function Const bool Returns whether this handler is initialized
Public function Const bool

IsValid ()

 Return whether this handler is valid
Public function Virtual void Notification that the analytics provider has been updated NOTE: Can also mean disabled, e.g. during hotfix
Public function Virtual void Notification to this component that it is ready to begin handshaking
Public function Virtual void

Outgoing ( FBitWriter& Packet,
FOutPacketTraits& Traits
)

 Handles any outgoing packets
Public function Virtual void

OutgoingConnectionless ( const TSharedPtr< const FInternetAddr >& Address,
FBitWriter& Packet,
FOutPacketTraits& Traits
)

 Handles any outgoing packets not associated with a UNetConnection
Public function Const bool Returns whether this handler perform a network handshake during initialization
Public function Const bool Returns whether this handler perform a network handshake during initialization
Public function Virtual void

SetActive ( bool Active
)

 Sets whether this handler is currently active
Protected function void Sets the state of the handler
Public function Virtual void

Tick ( float DeltaTime
)

 Tick functionality should be placed here

Deprecated Functions

  Type Name Description
Public function Virtual void

Incoming ( FBitReader& Packet
)

 Use the version of 'HandlerComponent::Incoming' which takes 'FIncomingPacketRef' instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page