I love the smell of UnrealEd crashing in the morning. – tarquin

UE3:MeshBeacon (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site

Jump to: navigation, search
UDK Object >> MeshBeacon

Contents

Package: 
IpDrv
Direct subclasses:
MeshBeaconClient, MeshBeaconHost

This class is the base class for the client/host mesh beacon classes.

[edit] Properties

[edit] BeaconName

Type: name

The name to use when logging (helps debugging)

[edit] bIsInTick

Type: bool

Modifiers: transient

Used to determine whether to use deferred destruction or not

[edit] bShouldTick

Type: bool

Whether to the socket(s) or not (not during travel)

Default value: True

[edit] bWantsDeferredDestroy

Type: bool

Modifiers: transient

True if the beacon should be destroyed at the end of the tick

[edit] ElapsedHeartbeatTime

Type: float

The elapsed time that has passed since the last heartbeat

[edit] HeartbeatTimeout

Type: float

Modifiers: config

The maximum amount of time to pass between heartbeat packets being sent

[edit] MaxBandwidthHistoryEntries

Type: int

Modifiers: config

Maximum number of entries allowed for the bandwidth history of a client connection

[edit] MaxBandwidthTestBufferSize

Type: int

Modifiers: config

Maximum size of data that is allowed to be sent for bandwidth testing

[edit] MaxBandwidthTestReceiveTime

Type: float

Modifiers: config

Maximum time allowed to receive the buffer for bandwidth testing

[edit] MaxBandwidthTestSendTime

Type: float

Modifiers: config

Maximum time allowed to send the buffer for bandwidth testing

[edit] MeshBeaconPort

Type: int

Modifiers: config

The port that the mesh beacon will listen on

[edit] MinBandwidthTestBufferSize

Type: int

Modifiers: config

Minimum size of data that is required to be sent for acurate bandwidth testing

[edit] Socket

Type: pointer{FSocket}

Modifiers: native, transient

The object that is used to send/receive data with the remote host/client

[edit] SocketReceiveBufferSize

Type: int

Modifiers: config

Size of socket recv buffer. Once this is filled then socket blocks on the next recv.

[edit] SocketSendBufferSize

Type: int

Modifiers: config

Size of socket send buffer. Once this is filled then socket blocks on the next send.

[edit] Enums

[edit] EMeshBeaconBandwidthTestResult

Result of a bandwidth test between host/clietn connection

MB_BandwidthTestResult_Succeeded 
MB_BandwidthTestResult_Timeout 
MB_BandwidthTestResult_Error 

[edit] EMeshBeaconBandwidthTestState

State of current bandwidth testing on a client connection

MB_BandwidthTestState_NotStarted 
MB_BandwidthTestState_RequestPending 
MB_BandwidthTestState_StartPending 
MB_BandwidthTestState_InProgress 
MB_BandwidthTestState_Completed 
MB_BandwidthTestState_Incomplete 
MB_BandwidthTestState_Timeout 
MB_BandwidthTestState_Error 

[edit] EMeshBeaconBandwidthTestType

Bandwidth tests that are supported

MB_BandwidthTestType_Upstream 
MB_BandwidthTestType_Downstream 
MB_BandwidthTestType_RoundtripLatency 

[edit] EMeshBeaconConnectionResult

Result of a new client connection request

MB_ConnectionResult_Succeeded 
MB_ConnectionResult_Duplicate 
MB_ConnectionResult_Timeout 
MB_ConnectionResult_Error 

[edit] EMeshBeaconPacketType

Packet ids used to communicate between host & client mesh beacons

MB_Packet_UnknownType 
MB_Packet_ClientNewConnectionRequest 
MB_Packet_ClientBeginBandwidthTest 
MB_Packet_ClientCreateNewSessionResponse 
MB_Packet_HostNewConnectionResponse 
MB_Packet_HostBandwidthTestRequest 
MB_Packet_HostCompletedBandwidthTest 
MB_Packet_HostTravelRequest 
MB_Packet_HostCreateNewSessionRequest 
MB_Packet_DummyData 
MB_Packet_Heartbeat 

[edit] Structs

[edit] ConnectionBandwidthStats

Modifiers: native

Bandwidth data for a connection

int UpstreamRate 
Upstream rate in bytes per second
int DownstreamRate 
Downstream rate in bytes per second
int RoundtripLatency 
Roundtrip latency in milliseconds

[edit] PlayerMember

Modifiers: native

Player that is to be a member of a new session

int TeamNum 
The team the player is on
int Skill 
The skill rating of the player
OnlineSubsystem.UniqueNetId NetId 
The unique net id for the player

[edit] Native functions

[edit] DestroyBeacon

native event DestroyBeacon ()

Stops listening for requests/responses and releases any allocated memory

Personal tools