Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

NetworkTransport.GetOutgoingMessageQueueSize

public static int GetOutgoingMessageQueueSize(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 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.

Did you find this page useful? Please give it a rating: