Skip to main content

IServerEvents

Assembly: ServiceStack.dll​
View Source​
Declaration
public interface IServerEvents : IDisposable

Methods​

NotifyAll(String, Object)​

View Source​
Declaration
void NotifyAll(string selector, object message)
Parameters​
TypeName
System.Stringselector
System.Objectmessage

NotifyAllAsync(String, Object, CancellationToken)​

View Source​
Declaration
Task NotifyAllAsync(string selector, object message, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.Stringselector
System.Objectmessage
System.Threading.CancellationTokentoken

NotifyAllJsonAsync(String, String, CancellationToken)​

View Source​
Declaration
Task NotifyAllJsonAsync(string selector, string json, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.Stringselector
System.Stringjson
System.Threading.CancellationTokentoken

NotifyChannel(String, String, Object)​

View Source​
Declaration
void NotifyChannel(string channel, string selector, object message)
Parameters​
TypeName
System.Stringchannel
System.Stringselector
System.Objectmessage

NotifyChannelAsync(String, String, Object, CancellationToken)​

View Source​
Declaration
Task NotifyChannelAsync(string channel, string selector, object message, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.Stringchannel
System.Stringselector
System.Objectmessage
System.Threading.CancellationTokentoken

NotifyChannelJsonAsync(String, String, String, CancellationToken)​

View Source​
Declaration
Task NotifyChannelJsonAsync(string channel, string selector, string json, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.Stringchannel
System.Stringselector
System.Stringjson
System.Threading.CancellationTokentoken

NotifySubscription(String, String, Object, String)​

View Source​
Declaration
void NotifySubscription(string subscriptionId, string selector, object message, string channel = null)
Parameters​
TypeName
System.StringsubscriptionId
System.Stringselector
System.Objectmessage
System.Stringchannel

NotifySubscriptionAsync(String, String, Object, String, CancellationToken)​

View Source​
Declaration
Task NotifySubscriptionAsync(string subscriptionId, string selector, object message, string channel = null, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringsubscriptionId
System.Stringselector
System.Objectmessage
System.Stringchannel
System.Threading.CancellationTokentoken

NotifySubscriptionJsonAsync(String, String, String, String, CancellationToken)​

View Source​
Declaration
Task NotifySubscriptionJsonAsync(string subscriptionId, string selector, string json, string channel = null, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringsubscriptionId
System.Stringselector
System.Stringjson
System.Stringchannel
System.Threading.CancellationTokentoken

NotifyUserId(String, String, Object, String)​

View Source​
Declaration
void NotifyUserId(string userId, string selector, object message, string channel = null)
Parameters​
TypeName
System.StringuserId
System.Stringselector
System.Objectmessage
System.Stringchannel

NotifyUserIdAsync(String, String, Object, String, CancellationToken)​

View Source​
Declaration
Task NotifyUserIdAsync(string userId, string selector, object message, string channel = null, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringuserId
System.Stringselector
System.Objectmessage
System.Stringchannel
System.Threading.CancellationTokentoken

NotifyUserIdJsonAsync(String, String, String, String, CancellationToken)​

View Source​
Declaration
Task NotifyUserIdJsonAsync(string userId, string selector, string json, string channel = null, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringuserId
System.Stringselector
System.Stringjson
System.Stringchannel
System.Threading.CancellationTokentoken

NotifyUserName(String, String, Object, String)​

View Source​
Declaration
void NotifyUserName(string userName, string selector, object message, string channel = null)
Parameters​
TypeName
System.StringuserName
System.Stringselector
System.Objectmessage
System.Stringchannel

NotifyUserNameAsync(String, String, Object, String, CancellationToken)​

View Source​
Declaration
Task NotifyUserNameAsync(string userName, string selector, object message, string channel = null, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringuserName
System.Stringselector
System.Objectmessage
System.Stringchannel
System.Threading.CancellationTokentoken

NotifyUserNameJsonAsync(String, String, String, String, CancellationToken)​

View Source​
Declaration
Task NotifyUserNameJsonAsync(string userName, string selector, string json, string channel = null, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringuserName
System.Stringselector
System.Stringjson
System.Stringchannel
System.Threading.CancellationTokentoken

NotifySession(String, String, Object, String)​

View Source​
Declaration
void NotifySession(string sessionId, string selector, object message, string channel = null)
Parameters​
TypeName
System.StringsessionId
System.Stringselector
System.Objectmessage
System.Stringchannel

NotifySessionAsync(String, String, Object, String, CancellationToken)​

View Source​
Declaration
Task NotifySessionAsync(string sessionId, string selector, object message, string channel = null, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringsessionId
System.Stringselector
System.Objectmessage
System.Stringchannel
System.Threading.CancellationTokentoken

NotifySessionJsonAsync(String, String, String, String, CancellationToken)​

View Source​
Declaration
Task NotifySessionJsonAsync(string sessionId, string selector, string json, string channel = null, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringsessionId
System.Stringselector
System.Stringjson
System.Stringchannel
System.Threading.CancellationTokentoken

GetSubscriptionInfo(String)​

View Source​
Declaration
SubscriptionInfo GetSubscriptionInfo(string id)
Returns​

ServiceStack.SubscriptionInfo

Parameters​
TypeName
System.Stringid

GetSubscriptionInfosByUserId(String)​

View Source​
Declaration
List<SubscriptionInfo> GetSubscriptionInfosByUserId(string userId)
Returns​

System.Collections.Generic.List<ServiceStack.SubscriptionInfo>

Parameters​
TypeName
System.StringuserId

GetAllSubscriptionInfos()​

View Source​
Declaration
List<SubscriptionInfo> GetAllSubscriptionInfos()
Returns​

System.Collections.Generic.List<ServiceStack.SubscriptionInfo>

RegisterAsync(IEventSubscription, Dictionary<String, String>, CancellationToken)​

View Source​
Declaration
Task RegisterAsync(IEventSubscription subscription, Dictionary<string, string> connectArgs = null, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
ServiceStack.IEventSubscriptionsubscription
System.Collections.Generic.Dictionary<System.String,System.String>connectArgs
System.Threading.CancellationTokentoken

UnRegisterAsync(String, CancellationToken)​

View Source​
Declaration
Task UnRegisterAsync(string subscriptionId, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringsubscriptionId
System.Threading.CancellationTokentoken

GetNextSequence(String)​

View Source​
Declaration
long GetNextSequence(string sequenceId)
Returns​

System.Int64

Parameters​
TypeName
System.StringsequenceId

RemoveExpiredSubscriptions()​

View Source​
Declaration
int RemoveExpiredSubscriptions()
Returns​

System.Int32

RemoveExpiredSubscriptionsAsync(CancellationToken)​

View Source​
Declaration
Task<int> RemoveExpiredSubscriptionsAsync(CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task<System.Int32>

Parameters​
TypeName
System.Threading.CancellationTokentoken

SubscribeToChannels(String, String[])​

View Source​
Declaration
void SubscribeToChannels(string subscriptionId, string[] channels)
Parameters​
TypeName
System.StringsubscriptionId
System.String[]channels

SubscribeToChannelsAsync(String, String[], CancellationToken)​

View Source​
Declaration
Task SubscribeToChannelsAsync(string subscriptionId, string[] channels, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringsubscriptionId
System.String[]channels
System.Threading.CancellationTokentoken

UnsubscribeFromChannels(String, String[])​

View Source​
Declaration
void UnsubscribeFromChannels(string subscriptionId, string[] channels)
Parameters​
TypeName
System.StringsubscriptionId
System.String[]channels

UnsubscribeFromChannelsAsync(String, String[], CancellationToken)​

View Source​
Declaration
Task UnsubscribeFromChannelsAsync(string subscriptionId, string[] channels, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
System.StringsubscriptionId
System.String[]channels
System.Threading.CancellationTokentoken

QueueAsyncTask(Func<Task>)​

View Source​
Declaration
void QueueAsyncTask(Func<Task> task)
Parameters​
TypeName
System.Func<System.Threading.Tasks.Task>task

GetMemoryServerEvents()​

View Source​
Declaration
MemoryServerEvents GetMemoryServerEvents()
Returns​

ServiceStack.MemoryServerEvents

GetSubscriptionsDetails(String[])​

View Source​
Declaration
List<Dictionary<string, string>> GetSubscriptionsDetails(params string[] channels)
Returns​

System.Collections.Generic.List<System.Collections.Generic.Dictionary<System.String,System.String>>

Parameters​
TypeName
System.String[]channels

GetAllSubscriptionsDetails()​

View Source​
Declaration
List<Dictionary<string, string>> GetAllSubscriptionsDetails()
Returns​

System.Collections.Generic.List<System.Collections.Generic.Dictionary<System.String,System.String>>

PulseAsync(String, CancellationToken)​

View Source​
Declaration
Task<bool> PulseAsync(string subscriptionId, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task<System.Boolean>

Parameters​
TypeName
System.StringsubscriptionId
System.Threading.CancellationTokentoken

Reset()​

View Source​
Declaration
void Reset()

Start()​

View Source​
Declaration
void Start()

Stop()​

View Source​
Declaration
void Stop()

StopAsync()​

View Source​
Declaration
Task StopAsync()
Returns​

System.Threading.Tasks.Task

GetStats()​

View Source​
Declaration
Dictionary<string, string> GetStats()
Returns​

System.Collections.Generic.Dictionary<System.String,System.String>