Sandbox.ModAPI.Ingame.IMyBroadcastListener

← Index ← Namespace Index

IMyBroadcastListener Interface

public interface IMyBroadcastListener: IMyMessageProvider

Broadcast listeners scan the network for broadcasted messages with specific tag.

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll

Implements:

• IMyMessageProvider

Properties

bool IsActive { get; }

Gets a value that indicates whether the broadcast listener is active.

string Tag { get; }

Gets the tag this broadcast listener is listening for.

bool HasPendingMessage { get; }

Determines whether there is a message pending to be accepted in this message provider or not. There may be multiple messages pending in single message provider. In such case the flag will stay raised until the last message is consumed.

Inherited from IMyMessageProvider

int MaxWaitingMessages { get; }

Indicates number of max messages waiting in queue before the oldest one will be dropped to make space for new one.

Inherited from IMyMessageProvider

Methods

MyIGCMessage AcceptMessage()

Accepts first message from pending message queue for this message provider. Messages are guaranteed to be dequeued and returned by this method in order they arrived.

Inherited from IMyMessageProvider

void DisableMessageCallback()

Disables registered message callback.

Inherited from IMyMessageProvider

void SetMessageCallback(string argument = "")

Whenever given message provider obtains new message respective programmable block gets called with provided argument. Each raised callback argument will be called only once per simulation tick no matter how many messages are there pending to be accepted. At most a single callback will be invoked each tick ==> If there are messages pending in multiple message providers with registered callback, one will be randomly picked and invoked. Rest will be deferred to the next tick and follow the same process. In case you don't consume all messages pending in given message provider, the callback will not be raise again in following tick unless new message arrives.

Inherited from IMyMessageProvider