Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

NetworkTransport.GetIncomingMessageQueueSize

Other Versions
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function GetIncomingMessageQueueSize(hostId: int, out error: byte): int;
public static int GetIncomingMessageQueueSize(int hostId, out byte error);

Parameters

hostId Host ID associated with this queue.
error Error code. Cast this value to NetworkError for more information.

Returns

int The number of messages in the queue.

Description

Returns the number of received messages waiting in the queue for processing.

Messages received by Unity Multiplayer are stored in a queue ready to be processed. This function tells you how many messages are in the queue. If the queue ever reaches its capacity (which is given by GlobalConfig.ReactorMaximumReceivedMessages), any further received messages are dropped.

Leave Feedback

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2017 Unity Technologies. Publication: 5.6-001M. Built: 2017-06-19.
Tutorials Community Answers Knowledge Base Forums Asset Store