Photon Server API
Public Member Functions | Properties | List of all members
ExitGames.Messaging.Channels.IMessageQueue< T > Interface Template Reference

The implementor stores messages of type T. More...

Inheritance diagram for ExitGames.Messaging.Channels.IMessageQueue< T >:
ExitGames.Messaging.Channels.MessageQueue< T > ExitGames.Messaging.Channels.LockedMessageQueue< T >

Public Member Functions

List< T > Dequeue (int maxCount, Func< T, bool > skip)
 Dequeues up to the given amount of messages. More...
 
Dequeue ()
 Dequeues the next message. More...
 
List< T > Dequeue (int maxCount)
 Dequeues up to the given amount of messages. More...
 
List< T > DequeueAll (Func< T, bool > skip)
 Dequeues all messages. More...
 
List< T > DequeueAll ()
 Dequeues all messages. More...
 
void Enqueue (T message)
 Enqueues a message. More...
 
bool IsSubscribed (string topic)
 Checks if queue is subscribed to a channel with a certain topic. More...
 
bool Subscribe (string topic, Concurrency.Channels.IChannel< T > channel)
 Subscribes to a Concurrency.Channels.IChannel<T> with a topic. More...
 
bool Unsubscribe (string topic)
 Unsubscribes from a topic channel. More...
 

Properties

int Count [get]
 Gets the number of queued message. More...
 

Detailed Description

The implementor stores messages of type T.

Template Parameters
TThe message type.

Member Function Documentation

List<T> ExitGames.Messaging.Channels.IMessageQueue< T >.Dequeue ( int  maxCount,
Func< T, bool >  skip 
)

Dequeues up to the given amount of messages.

Parameters
maxCountThe max number of messages to dequeue.
skipA message filter.
Returns
A list of messages.

Implemented in ExitGames.Messaging.Channels.MessageQueue< T >, and ExitGames.Messaging.Channels.LockedMessageQueue< T >.

Dequeues the next message.

Returns
A message.

Implemented in ExitGames.Messaging.Channels.MessageQueue< T >, and ExitGames.Messaging.Channels.LockedMessageQueue< T >.

List<T> ExitGames.Messaging.Channels.IMessageQueue< T >.Dequeue ( int  maxCount)

Dequeues up to the given amount of messages.

Parameters
maxCountThe max number of messages to dequeue.
Returns
A list of messages.

Implemented in ExitGames.Messaging.Channels.MessageQueue< T >, and ExitGames.Messaging.Channels.LockedMessageQueue< T >.

List<T> ExitGames.Messaging.Channels.IMessageQueue< T >.DequeueAll ( Func< T, bool >  skip)

Dequeues all messages.

Parameters
skipA message filter.
Returns
A list of messages.

Implemented in ExitGames.Messaging.Channels.MessageQueue< T >, and ExitGames.Messaging.Channels.LockedMessageQueue< T >.

List<T> ExitGames.Messaging.Channels.IMessageQueue< T >.DequeueAll ( )

Dequeues all messages.

Returns
A list of messages.

Implemented in ExitGames.Messaging.Channels.MessageQueue< T >, and ExitGames.Messaging.Channels.LockedMessageQueue< T >.

void ExitGames.Messaging.Channels.IMessageQueue< T >.Enqueue ( message)

Enqueues a message.

Parameters
messageA message.

Implemented in ExitGames.Messaging.Channels.MessageQueue< T >, and ExitGames.Messaging.Channels.LockedMessageQueue< T >.

bool ExitGames.Messaging.Channels.IMessageQueue< T >.IsSubscribed ( string  topic)

Checks if queue is subscribed to a channel with a certain topic.

Parameters
topicThe topic.
Returns
True if subscribed.

Implemented in ExitGames.Messaging.Channels.MessageQueue< T >, and ExitGames.Messaging.Channels.LockedMessageQueue< T >.

bool ExitGames.Messaging.Channels.IMessageQueue< T >.Subscribe ( string  topic,
Concurrency.Channels.IChannel< T >  channel 
)

Subscribes to a Concurrency.Channels.IChannel<T> with a topic.

Parameters
topicThe channel topic.
channelThe channel.
Returns
True if resubscribed, false if subscribed first time.

Implemented in ExitGames.Messaging.Channels.MessageQueue< T >, and ExitGames.Messaging.Channels.LockedMessageQueue< T >.

bool ExitGames.Messaging.Channels.IMessageQueue< T >.Unsubscribe ( string  topic)

Unsubscribes from a topic channel.

Parameters
topicThe topic.
Returns
True if unsubscribed.

Implemented in ExitGames.Messaging.Channels.MessageQueue< T >, and ExitGames.Messaging.Channels.LockedMessageQueue< T >.

Property Documentation

Gets the number of queued message.