Class WolfClient

A default base wolf client implementation.

Inheritance

Object

WolfClient

Implements

IWolfClient

IWolfClientCacheAccessor

IDisposable

Namespace: TehGM.Wolfringo

Assembly: Wolfringo.Core.dll

Syntax

public class WolfClient : IWolfClient, IWolfClientCacheAccessor, IDisposable

Remarks

This implementation, together with IHostedWolfClient from Wolfringo.Hosting package, is the default intended way to use Wolfringo library. It's based on message and response serializers, which combined with constructor Dependency Injection provide high degree of customizability.

Custom SocketIO client SocketClient is used by this library. This client only provides functionality required for Wolf, and may not be suitable for other scenarios.

This implementation automatically handles cache updates whenever a correct type of message or response is sent or received. For this reason, it's important to be careful when overriding OnMessageSentAsync(IWolfMessage, IWolfResponse, SerializedMessageData, CancellationToken) and OnMessageReceivedAsync(IWolfMessage, SerializedMessageData, CancellationToken), as not calling base implementation (or not implementing replacement behaviour) might cause functionality loss.

Constructors

WolfClient()

Creates a new wolf client instance.

Declaration

[Obsolete("Use WolfClientBuilder instead")]
public WolfClient()

WolfClient(ILogger)

Creates a new wolf client instance.

Declaration

[Obsolete("Use WolfClientBuilder instead")]
public WolfClient(ILogger log)

Parameters

Type	Name	Description
ILogger	log	Logger to use with this client. If null, no messages will be logged.

WolfClient(ILoggerFactory)

Creates a new wolf client instance.

Declaration

[Obsolete("Use WolfClientBuilder instead")]
public WolfClient(ILoggerFactory logFactory)

Parameters

Type	Name	Description
ILoggerFactory	logFactory	Logger factory to use with this client. If null, no messages will be logged.

WolfClient(IServiceProvider, WolfClientOptions)

Creates a new wolf client instance.

Declaration

public WolfClient(IServiceProvider services, WolfClientOptions options)

Parameters

Type	Name	Description
IServiceProvider	services	Services provider to resolve dependencies from.
WolfClientOptions	options	Options for this client.

Properties

Cache

Caches container.

Declaration

protected IWolfClientCache Cache { get; set; }

Property Value

Type	Description
IWolfClientCache

CallbackDispatcher

Callbacks dispatcher used by this WOLF client.

Declaration

protected MessageCallbackDispatcher CallbackDispatcher { get; }

Property Value

Type	Description
MessageCallbackDispatcher

CurrentUserID

Currently logged in user. Null if not connected.

Declaration

public uint? CurrentUserID { get; protected set; }

Property Value

Type	Description
Nullable<UInt32>

Device

Device to pass to the server when connecting.

Declaration

public WolfDevice Device { get; }

Property Value

Type	Description
WolfDevice

DisposablesHandler

Handler for tracking services that should be disposed when this WolfClient is being disposed.

Declaration

protected DisposableServicesHandler DisposablesHandler { get; }

Property Value

Type	Description
DisposableServicesHandler

IgnoreOwnChatMessages

Whether the client should skip raising events for messages it sent.

Declaration

protected bool IgnoreOwnChatMessages { get; }

Property Value

Type	Description
Boolean

IsConnected

Is this client currently connected?

Declaration

public bool IsConnected { get; }

Property Value

Type	Description
Boolean

Log

Logger for all log messages.

Declaration

protected ILogger Log { get; }

Property Value

Type	Description
ILogger

MessageSerializers

Message serializers mapping used when serializing and deserializing messages.

Declaration

protected ISerializerProvider<string, IMessageSerializer> MessageSerializers { get; }

Property Value

Type	Description
ISerializerProvider<String, IMessageSerializer>

ResponseSerializers

Response serializers mapping used when deserializing responses.

Declaration

protected ISerializerProvider<Type, IResponseSerializer> ResponseSerializers { get; }

Property Value

Type	Description
ISerializerProvider<Type, IResponseSerializer>

ResponseTypeResolver

Response type resolver used when deserializing responses.

Declaration

protected IResponseTypeResolver ResponseTypeResolver { get; }

Property Value

Type	Description
IResponseTypeResolver

SocketClient

Socket client used by this WOLF client.

Declaration

protected ISocketClient SocketClient { get; }

Property Value

Type	Description
ISocketClient

Token

Token used with the connection.

Declaration

protected string Token { get; }

Property Value

Type	Description
String

Url

URL of the server.

Declaration

public string Url { get; }

Property Value

Type	Description
String

Methods

AddMessageListener(IMessageCallback)

Adds event listener.

Declaration

public void AddMessageListener(IMessageCallback listener)

Parameters

Type	Name	Description
IMessageCallback	listener	Callback to invoke on event.

BuildDefaultServiceProvider(ILogger)

Builds default service provider. Used to temporarily support obsolete non-builder constructors.

Declaration

protected static IServiceProvider BuildDefaultServiceProvider(ILogger log = null)

Parameters

Type	Name	Description
ILogger	log	A logger to add to the services. If null, logging will be disabled.

Returns

Type	Description
IServiceProvider	A IServiceProvider with default services added.

Clear()

Clears all connection-bound variables.

Declaration

protected virtual void Clear()

ConnectAsync(CancellationToken)

Connects to the server.

Declaration

public Task ConnectAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Token to abort entire connection.

Returns

Type	Description
Task

ConnectAsync(WolfDevice, CancellationToken)

Declaration

public async Task ConnectAsync(WolfDevice device, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
WolfDevice	device	Device to connect as.
CancellationToken	cancellationToken	Cancellation token that can be used for Task cancellation.

Returns

Type	Description
Task

DisconnectAsync(CancellationToken)

Disconnects from the server.

Declaration

public Task DisconnectAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

Dispose()

Declaration

public virtual void Dispose()

OnMessageReceivedAsync(IWolfMessage, SerializedMessageData, CancellationToken)

Internal method for handling additional actions on received message.

Declaration

protected virtual Task OnMessageReceivedAsync(IWolfMessage message, SerializedMessageData rawMessage, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IWolfMessage	message	Received message.
SerializedMessageData	rawMessage	Raw received message.
CancellationToken	cancellationToken	Cancellation token that can be used for Task cancellation.

Returns

Type	Description
Task

Remarks

This method is invoked after client parses current user (for welcome) and caches the entities.

OnMessageSentAsync(IWolfMessage, IWolfResponse, SerializedMessageData, CancellationToken)

Internal method for handling additional actions on sent message.

Declaration

protected virtual Task OnMessageSentAsync(IWolfMessage message, IWolfResponse response, SerializedMessageData rawResponse, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IWolfMessage	message	Sent message.
IWolfResponse	response	Response received.
SerializedMessageData	rawResponse	Raw response data.
CancellationToken	cancellationToken	Cancellation token that can be used for Task cancellation.

Returns

Type	Description
Task

Remarks

This method is invoked after client parses current user (for login/logout), populates chat message body data, and caches the entities.

RemoveMessageListener(IMessageCallback)

Removes event listener.

Declaration

public void RemoveMessageListener(IMessageCallback listener)

Parameters

Type	Name	Description
IMessageCallback	listener	Callback to remove.

SendAsync<TResponse>(IWolfMessage, CancellationToken)

Sends message, and waits for response from the server.

Declaration

public async Task<TResponse> SendAsync<TResponse>(IWolfMessage message, CancellationToken cancellationToken = default(CancellationToken))
    where TResponse : IWolfResponse

Parameters

Type	Name	Description
IWolfMessage	message	Message to send.
CancellationToken	cancellationToken	Cancellation token that can be used for Task cancellation.

Returns

Type	Description
Task<TResponse>	Sending response.

Type Parameters

Name	Description
TResponse	Response type to use for casting of response.

Remarks

If client uses ResponseTypeResolver, the type of response provided with ResponseTypeAttribute on message will be used for deserialization, and TResponse will be used only for casting. If ResponseTypeAttribute is not set on message, TResponse will be used for deserialization as normal.

Exceptions

Type	Condition
MessageSendingException	Server responded with error.

TryLogMessageTrace(SocketMessageEventArgs, String)

Logs socket message event with trace log level.

Declaration

protected void TryLogMessageTrace(SocketMessageEventArgs e, string keyword)

Parameters

Type	Name	Description
SocketMessageEventArgs	e	Received socket event.
String	keyword	Keyword to prepend in log message, for example "Sent" or "Received".

TryParseCommandEvent(SocketMessage, out String, out JToken)

Tries to parse command and payload object.

Declaration

protected static bool TryParseCommandEvent(SocketMessage message, out string command, out JToken payload)

Parameters

Type	Name	Description
SocketMessage	message	Received socket message.
String	command	Parsed message command; null if not a command message.
Newtonsoft.Json.Linq.JToken	payload	Extracted payload.

Returns

Type	Description
Boolean	True if command parsed and is not null; otherwise false.

Events

Connected

Rasied when the client connects to the server.

Declaration

public event EventHandler Connected

Event Type

Type	Description
EventHandler

Disconnected

Raised when the client disconnects from the server.

Declaration

public event EventHandler Disconnected

Event Type

Type	Description
EventHandler

ErrorRaised

Raised when an error has occured.

Declaration

public event EventHandler<UnhandledExceptionEventArgs> ErrorRaised

Event Type

Type	Description
EventHandler<UnhandledExceptionEventArgs>

MessageReceived

Raised when the client receives an event from the server.

Declaration

public event EventHandler<WolfMessageEventArgs> MessageReceived

Event Type

Type	Description
EventHandler<WolfMessageEventArgs>

MessageSent

Raised when the client sends a message to the server.

Declaration

public event EventHandler<WolfMessageSentEventArgs> MessageSent

Event Type

Type	Description
EventHandler<WolfMessageSentEventArgs>

Explicit Interface Implementations

IWolfClientCacheAccessor.GetCachedAchievement(WolfLanguage, UInt32)

Get achievement from cache.

Declaration

WolfAchievement IWolfClientCacheAccessor.GetCachedAchievement(WolfLanguage language, uint id)

Parameters

Type	Name	Description
WolfLanguage	language	Language of achievement's translations.
UInt32	id	ID of the achievement.

Returns

Type	Description
WolfAchievement	Cached achievement if found in requested language; otherwise null.

IWolfClientCacheAccessor.GetCachedCharm(UInt32)

Get charm from cache.

Declaration

WolfCharm IWolfClientCacheAccessor.GetCachedCharm(uint id)

Parameters

Type	Name	Description
UInt32	id	ID of the charm.

Returns

Type	Description
WolfCharm	Cached charm if found; otherwise null.

IWolfClientCacheAccessor.GetCachedGroup(String)

Get group from cache.

Declaration

WolfGroup IWolfClientCacheAccessor.GetCachedGroup(string name)

Parameters

Type	Name	Description
String	name	Name of the group.

Returns

Type	Description
WolfGroup	Cached group if found; otherwise null.

IWolfClientCacheAccessor.GetCachedGroup(UInt32)

Get group from cache.

Declaration

WolfGroup IWolfClientCacheAccessor.GetCachedGroup(uint id)

Parameters

Type	Name	Description
UInt32	id	ID of the group.

Returns

Type	Description
WolfGroup	Cached group if found; otherwise null.

IWolfClientCacheAccessor.GetCachedUser(UInt32)

Get user from cache.

Declaration

WolfUser IWolfClientCacheAccessor.GetCachedUser(uint id)

Parameters

Type	Name	Description
UInt32	id	ID of the user.

Returns

Type	Description
WolfUser	Cached user if found; otherwise null.

Implements

IWolfClient

IWolfClientCacheAccessor

System.IDisposable

Extension Methods

InteractiveExtensions.AwaitNextAsync<T>(IWolfClient, Func<T, Boolean>, CancellationToken)

InteractiveExtensions.AwaitNextPrivateByUserAsync(IWolfClient, UInt32, CancellationToken)

InteractiveExtensions.AwaitNextGroupByUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

InteractiveExtensions.AwaitNextInGroupAsync(IWolfClient, UInt32, CancellationToken)

InteractiveExtensions.AwaitNextAsync<T>(IWolfClient, Func<T, Boolean>, TimeSpan, CancellationToken)

InteractiveExtensions.AwaitNextPrivateByUserAsync(IWolfClient, UInt32, TimeSpan, CancellationToken)

InteractiveExtensions.AwaitNextGroupByUserAsync(IWolfClient, UInt32, UInt32, TimeSpan, CancellationToken)

InteractiveExtensions.AwaitNextInGroupAsync(IWolfClient, UInt32, TimeSpan, CancellationToken)

Sender.LoginAsync(IWolfClient, String, String, WolfLoginType, CancellationToken)

Sender.LoginAsync(IWolfClient, String, String, CancellationToken)

Sender.LogoutAsync(IWolfClient, CancellationToken)

Sender.SubscribeAllMessagesAsync(IWolfClient, CancellationToken)

Sender.SubscribePrivateMessagesAsync(IWolfClient, CancellationToken)

Sender.SubscribeGroupMessagesAsync(IWolfClient, CancellationToken)

Sender.SubscribeGroupTipsAsync(IWolfClient, CancellationToken)

Sender.SetOnlineStateAsync(IWolfClient, WolfOnlineState, CancellationToken)

Sender.GetNotificationsAsync(IWolfClient, WolfLanguage, WolfDevice, CancellationToken)

Sender.GetNotificationsAsync(IWolfClient, CancellationToken)

Sender.ClearNotificationsAsync(IWolfClient, CancellationToken)

Sender.GetUsersAsync(IWolfClient, IEnumerable<UInt32>, CancellationToken)

Sender.GetCurrentUserAsync(IWolfClient, CancellationToken)

Sender.GetUserAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetContactListAsync(IWolfClient, CancellationToken)

Sender.AddContactAsync(IWolfClient, UInt32, CancellationToken)

Sender.DeleteContactAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetBlockedUsersAsync(IWolfClient, CancellationToken)

Sender.BlockUserAsync(IWolfClient, UInt32, CancellationToken)

Sender.UnblockUserAsync(IWolfClient, UInt32, CancellationToken)

Sender.UpdateProfileAsync(IWolfClient, Action<UserUpdateMessage.Builder>, CancellationToken)

Sender.UpdateNicknameAsync(IWolfClient, String, CancellationToken)

Sender.UpdateStatusAsync(IWolfClient, String, CancellationToken)

Sender.GetPrivateMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, Boolean, CancellationToken)

Sender.GetPrivateMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, CancellationToken)

Sender.GetPrivateMessageHistoryAsync(IWolfClient, UInt32, Boolean, CancellationToken)

Sender.GetPrivateMessageHistoryAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetGroupMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, Boolean, CancellationToken)

Sender.GetGroupMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, CancellationToken)

Sender.GetGroupMessageHistoryAsync(IWolfClient, UInt32, Boolean, CancellationToken)

Sender.GetGroupMessageHistoryAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetRecentConversationsAsync(IWolfClient, CancellationToken)

Sender.JoinGroupAsync(IWolfClient, UInt32, String, CancellationToken)

Sender.JoinGroupAsync(IWolfClient, UInt32, CancellationToken)

Sender.JoinGroupAsync(IWolfClient, String, String, CancellationToken)

Sender.JoinGroupAsync(IWolfClient, String, CancellationToken)

Sender.LeaveGroupAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetGroupsAsync(IWolfClient, IEnumerable<UInt32>, CancellationToken)

Sender.GetGroupAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetGroupAsync(IWolfClient, String, CancellationToken)

Sender.GetCurrentUserGroupsAsync(IWolfClient, CancellationToken)

Sender.GetGroupStatisticsAsync(IWolfClient, UInt32, CancellationToken)

Sender.CreateGroupAsync(IWolfClient, String, String, Action<GroupCreateMessage.Builder>, CancellationToken)

Sender.CreateGroupAsync(IWolfClient, String, String, CancellationToken)

Sender.UpdateGroupAsync(IWolfClient, UInt32, Action<GroupUpdateMessage.Builder>, CancellationToken)

Sender.UpdateGroupAudioConfigAsync(IWolfClient, UInt32, Action<GroupAudioUpdateMessage.Builder>, CancellationToken)

Sender.GetCharmsAsync(IWolfClient, IEnumerable<UInt32>, CancellationToken)

Sender.GetAllCharmsAsync(IWolfClient, CancellationToken)

Sender.GetCharmAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetUserCharmStatsAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetUserCurrentCharmAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetUserActiveCharmsAsync(IWolfClient, UInt32, CancellationToken)

Sender.GetUserExpiredCharmsAsync(IWolfClient, UInt32, CancellationToken)

Sender.SetActiveCharmAsync(IWolfClient, UInt32, CancellationToken)

Sender.RemoveActiveCharmAsync(IWolfClient, CancellationToken)

Sender.GetAchievementsAsync(IWolfClient, WolfLanguage, IEnumerable<UInt32>, CancellationToken)

Sender.GetAchievementAsync(IWolfClient, WolfLanguage, UInt32, CancellationToken)

Sender.GetAllAchievementsAsync(IWolfClient, WolfLanguage, CancellationToken)

Sender.GetUserAchievementsAsync(IWolfClient, UInt32, WolfLanguage, CancellationToken)

Sender.GetGroupAchievementsAsync(IWolfClient, UInt32, WolfLanguage, CancellationToken)

Sender.AdminUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Sender.ModUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Sender.ResetUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Sender.SilenceUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Sender.KickUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Sender.BanUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Sender.SendPrivateTextMessageAsync(IWolfClient, UInt32, String, CancellationToken)

Sender.SendGroupTextMessageAsync(IWolfClient, UInt32, String, CancellationToken)

Sender.SendPrivateImageMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)

Sender.SendGroupImageMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)

Sender.SendPrivateVoiceMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)

Sender.SendGroupVoiceMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)

Sender.ReplyTextAsync(IWolfClient, ChatMessage, String, CancellationToken)

Sender.ReplyImageAsync(IWolfClient, ChatMessage, IEnumerable<Byte>, CancellationToken)

Sender.ReplyVoiceAsync(IWolfClient, ChatMessage, IEnumerable<Byte>, CancellationToken)

Sender.DeleteChatMessageAsync(IWolfClient, ChatMessage, CancellationToken)

Sender.RestoreChatMessageAsync(IWolfClient, ChatMessage, CancellationToken)

Sender.GetLinkMetadataAsync(IWolfClient, String, CancellationToken)

Sender.GetMessageTipsSummaryAsync(IWolfClient, WolfTimestamp, UInt32, CancellationToken)

Sender.GetMessageTipsSummaryAsync(IWolfClient, IEnumerable<ChatMessage>, CancellationToken)

Sender.GetMessageTipsSummaryAsync(IWolfClient, ChatMessage, CancellationToken)

Sender.GetMessageTipsDetailsAsync(IWolfClient, ChatMessage, CancellationToken)

Sender.TipMessageAsync(IWolfClient, ChatMessage, UInt32, CancellationToken)

Sender.TipMessageAsync(IWolfClient, ChatMessage, IEnumerable<UInt32>, CancellationToken)

Sender.TipMessageAsync(IWolfClient, ChatMessage, WolfTip, CancellationToken)

Sender.TipMessageAsync(IWolfClient, ChatMessage, IEnumerable<WolfTip>, CancellationToken)

WolfClientExtensions.SendAsync(IWolfClient, IWolfMessage, CancellationToken)

WolfClientExtensions.AddMessageListener<T>(IWolfClient, Action<T>)

WolfClientExtensions.AddMessageListener<T>(IWolfClient, String, Action<T>)

WolfClientExtensions.RemoveMessageListener<T>(IWolfClient, Action<T>)

WolfGroupMembersHelper.RevalidateGroupMembersAsync(IWolfClient, WolfGroup, CancellationToken)