Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

NetworkTransport.GetOutgoingMessageQueueSize

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 method GetOutgoingMessageQueueSize(hostId: int, out error: byte): int;
public static int GetOutgoingMessageQueueSize(int hostId, out byte error);

Parameters

hostIdHost ID associated with this queue.
errorError code. Cast this value to NetworkError for more information.

Returns

int The number of messages waiting in the outgoing message queue to be sent.

Description

Returns the number of messages waiting in the outgoing message queue to be sent.

Messages waiting to be sent are placed in a queue. This queue can store GlobalConfig.MaxSentMessageQueueSize messages. If the queue is full when NetworkTransport.Send is called, Send() returns false allowing you to attempt to send your message again later or take other action.