Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ExecuteRemoveAsync method into IMemcachedResultsClient #121

Merged
merged 4 commits into from
Jun 15, 2019
Merged

Add ExecuteRemoveAsync method into IMemcachedResultsClient #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b58ed04
Save TextSocketHelper.cs with utf-8 encoding
cnblogs-dudu Jun 15, 2019
b2bf7c3
Convert tab to spaces in TextSocketHelper
cnblogs-dudu Jun 15, 2019
f42d21a
Fix infinite loop issue in TextSocketHelper.ReadLine
cnblogs-dudu Jun 15, 2019
7b788e5
Add ExecuteRemoveAsync method into IMemcachedResultsClient
cnblogs-dudu Jun 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 39 additions & 37 deletions Enyim.Caching/IMemcachedResultsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,55 +2,57 @@
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Enyim.Caching.Memcached;
using Enyim.Caching.Memcached.Results;

namespace Enyim.Caching
{
/// <summary>
/// Interface for API methods that return detailed operation results
/// </summary>
public interface IMemcachedResultsClient
{
IGetOperationResult ExecuteGet(string key);
IGetOperationResult<T> ExecuteGet<T>(string key);
IDictionary<string, IGetOperationResult> ExecuteGet(IEnumerable<string> keys);
/// <summary>
/// Interface for API methods that return detailed operation results
/// </summary>
public interface IMemcachedResultsClient
{
IGetOperationResult ExecuteGet(string key);
IGetOperationResult<T> ExecuteGet<T>(string key);
IDictionary<string, IGetOperationResult> ExecuteGet(IEnumerable<string> keys);

IGetOperationResult ExecuteTryGet(string key, out object value);

IStoreOperationResult ExecuteStore(StoreMode mode, string key, object value);
IStoreOperationResult ExecuteStore(StoreMode mode, string key, object value, DateTime expiresAt);
IStoreOperationResult ExecuteStore(StoreMode mode, string key, object value, TimeSpan validFor);
IGetOperationResult ExecuteTryGet(string key, out object value);

IStoreOperationResult ExecuteCas(StoreMode mode, string key, object value);
IStoreOperationResult ExecuteCas(StoreMode mode, string key, object value, ulong cas);
IStoreOperationResult ExecuteCas(StoreMode mode, string key, object value, DateTime expiresAt, ulong cas);
IStoreOperationResult ExecuteCas(StoreMode mode, string key, object value, TimeSpan validFor, ulong cas);
IStoreOperationResult ExecuteStore(StoreMode mode, string key, object value);
IStoreOperationResult ExecuteStore(StoreMode mode, string key, object value, DateTime expiresAt);
IStoreOperationResult ExecuteStore(StoreMode mode, string key, object value, TimeSpan validFor);

IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, DateTime expiresAt);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, TimeSpan validFor);
IStoreOperationResult ExecuteCas(StoreMode mode, string key, object value);
IStoreOperationResult ExecuteCas(StoreMode mode, string key, object value, ulong cas);
IStoreOperationResult ExecuteCas(StoreMode mode, string key, object value, DateTime expiresAt, ulong cas);
IStoreOperationResult ExecuteCas(StoreMode mode, string key, object value, TimeSpan validFor, ulong cas);

IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, ulong cas);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, DateTime expiresAt, ulong cas);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, TimeSpan validFor, ulong cas);

IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta);
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, DateTime expiresAt);
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, TimeSpan validFor);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, DateTime expiresAt);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, TimeSpan validFor);

IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, ulong cas);
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, DateTime expiresAt, ulong cas);
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, TimeSpan validFor, ulong cas);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, ulong cas);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, DateTime expiresAt, ulong cas);
IMutateOperationResult ExecuteDecrement(string key, ulong defaultValue, ulong delta, TimeSpan validFor, ulong cas);

IConcatOperationResult ExecuteAppend(string key, ArraySegment<byte> data);
IConcatOperationResult ExecuteAppend(string key, ulong cas, ArraySegment<byte> data);

IConcatOperationResult ExecutePrepend(string key, ArraySegment<byte> data);
IConcatOperationResult ExecutePrepend(string key, ulong cas, ArraySegment<byte> data);
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta);
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, DateTime expiresAt);
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, TimeSpan validFor);

IRemoveOperationResult ExecuteRemove(string key);
}
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, ulong cas);
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, DateTime expiresAt, ulong cas);
IMutateOperationResult ExecuteIncrement(string key, ulong defaultValue, ulong delta, TimeSpan validFor, ulong cas);

IConcatOperationResult ExecuteAppend(string key, ArraySegment<byte> data);
IConcatOperationResult ExecuteAppend(string key, ulong cas, ArraySegment<byte> data);

IConcatOperationResult ExecutePrepend(string key, ArraySegment<byte> data);
IConcatOperationResult ExecutePrepend(string key, ulong cas, ArraySegment<byte> data);

IRemoveOperationResult ExecuteRemove(string key);
Task<IRemoveOperationResult> ExecuteRemoveAsync(string key);
}
}

#region [ License information ]
Expand Down
238 changes: 121 additions & 117 deletions Enyim.Caching/Memcached/Protocol/Text/TextSocketHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,126 +1,130 @@
using System;
using System;
using System.IO;
using System.Text;
using System.Collections.Generic;

namespace Enyim.Caching.Memcached.Protocol.Text
{
internal static class TextSocketHelper
{
private const string GenericErrorResponse = "ERROR";
private const string ClientErrorResponse = "CLIENT_ERROR ";
private const string ServerErrorResponse = "SERVER_ERROR ";
private const int ErrorResponseLength = 13;

public const string CommandTerminator = "\r\n";

private static readonly Enyim.Caching.ILog log = Enyim.Caching.LogManager.GetLogger(typeof(TextSocketHelper));

/// <summary>
/// Reads the response of the server.
/// </summary>
/// <returns>The data sent by the memcached server.</returns>
/// <exception cref="T:System.InvalidOperationException">The server did not sent a response or an empty line was returned.</exception>
/// <exception cref="T:Enyim.Caching.Memcached.MemcachedException">The server did not specified any reason just returned the string ERROR. - or - The server returned a SERVER_ERROR, in this case the Message of the exception is the message returned by the server.</exception>
/// <exception cref="T:Enyim.Caching.Memcached.MemcachedClientException">The server did not recognize the request sent by the client. The Message of the exception is the message returned by the server.</exception>
public static string ReadResponse(PooledSocket socket)
{
string response = TextSocketHelper.ReadLine(socket);

if (log.IsDebugEnabled)
log.Debug("Received response: " + response);

if (String.IsNullOrEmpty(response))
throw new MemcachedClientException("Empty response received.");

if (String.Compare(response, GenericErrorResponse, StringComparison.Ordinal) == 0)
throw new NotSupportedException("Operation is not supported by the server or the request was malformed. If the latter please report the bug to the developers.");

if (response.Length >= ErrorResponseLength)
{
if (String.Compare(response, 0, ClientErrorResponse, 0, ErrorResponseLength, StringComparison.Ordinal) == 0)
{
throw new MemcachedClientException(response.Remove(0, ErrorResponseLength));
}
else if (String.Compare(response, 0, ServerErrorResponse, 0, ErrorResponseLength, StringComparison.Ordinal) == 0)
{
throw new MemcachedException(response.Remove(0, ErrorResponseLength));
}
}

return response;
}


/// <summary>
/// Reads a line from the socket. A line is terninated by \r\n.
/// </summary>
/// <returns></returns>
private static string ReadLine(PooledSocket socket)
{
MemoryStream ms = new MemoryStream(50);

bool gotR = false;
//byte[] buffer = new byte[1];

int data;

while (true)
{
data = socket.ReadByte();

if (data == 13)
{
gotR = true;
continue;
}

if (gotR)
{
if (data == 10)
break;

ms.WriteByte(13);

gotR = false;
}

ms.WriteByte((byte)data);
}

string retval = Encoding.ASCII.GetString(ms.ToArray(), 0, (int)ms.Length);

if (log.IsDebugEnabled)
log.Debug("ReadLine: " + retval);

return retval;
}

/// <summary>
/// Gets the bytes representing the specified command. returned buffer can be used to streamline multiple writes into one Write on the Socket
/// using the <see cref="M:Enyim.Caching.Memcached.PooledSocket.Write(IList&lt;ArraySegment&lt;byte&gt;&gt;)"/>
/// </summary>
/// <param name="value">The command to be converted.</param>
/// <returns>The buffer containing the bytes representing the command. The command must be terminated by \r\n.</returns>
/// <remarks>The Nagle algorithm is disabled on the socket to speed things up, so it's recommended to convert a command into a buffer
/// and use the <see cref="M:Enyim.Caching.Memcached.PooledSocket.Write(IList&lt;ArraySegment&lt;byte&gt;&gt;)"/> to send the command and the additional buffers in one transaction.</remarks>
public unsafe static IList<ArraySegment<byte>> GetCommandBuffer(string value)
{
var data = new ArraySegment<byte>(Encoding.ASCII.GetBytes(value));

return new ArraySegment<byte>[] { data };
}

public unsafe static IList<ArraySegment<byte>> GetCommandBuffer(string value, IList<ArraySegment<byte>> list)
{
var data = new ArraySegment<byte>(Encoding.ASCII.GetBytes(value));

list.Add(data);

return list;
}

}
internal static class TextSocketHelper
{
private const string GenericErrorResponse = "ERROR";
private const string ClientErrorResponse = "CLIENT_ERROR ";
private const string ServerErrorResponse = "SERVER_ERROR ";
private const int ErrorResponseLength = 13;

public const string CommandTerminator = "\r\n";

private static readonly Enyim.Caching.ILog log = Enyim.Caching.LogManager.GetLogger(typeof(TextSocketHelper));

/// <summary>
/// Reads the response of the server.
/// </summary>
/// <returns>The data sent by the memcached server.</returns>
/// <exception cref="T:System.InvalidOperationException">The server did not sent a response or an empty line was returned.</exception>
/// <exception cref="T:Enyim.Caching.Memcached.MemcachedException">The server did not specified any reason just returned the string ERROR. - or - The server returned a SERVER_ERROR, in this case the Message of the exception is the message returned by the server.</exception>
/// <exception cref="T:Enyim.Caching.Memcached.MemcachedClientException">The server did not recognize the request sent by the client. The Message of the exception is the message returned by the server.</exception>
public static string ReadResponse(PooledSocket socket)
{
string response = TextSocketHelper.ReadLine(socket);

if (log.IsDebugEnabled)
log.Debug("Received response: " + response);

if (String.IsNullOrEmpty(response))
throw new MemcachedClientException("Empty response received.");

if (String.Compare(response, GenericErrorResponse, StringComparison.Ordinal) == 0)
throw new NotSupportedException("Operation is not supported by the server or the request was malformed. If the latter please report the bug to the developers.");

if (response.Length >= ErrorResponseLength)
{
if (String.Compare(response, 0, ClientErrorResponse, 0, ErrorResponseLength, StringComparison.Ordinal) == 0)
{
throw new MemcachedClientException(response.Remove(0, ErrorResponseLength));
}
else if (String.Compare(response, 0, ServerErrorResponse, 0, ErrorResponseLength, StringComparison.Ordinal) == 0)
{
throw new MemcachedException(response.Remove(0, ErrorResponseLength));
}
}

return response;
}

/// <summary>
/// Reads a line from the socket. A line is terninated by \r\n.
/// </summary>
/// <returns></returns>
private static string ReadLine(PooledSocket socket)
{
var ms = new MemoryStream(50);

bool gotR = false;
//byte[] buffer = new byte[1];

int data;

while (true)
{
data = socket.ReadByte();

if (data == -1)
{
return string.Empty;
}

if (data == 13)
{
gotR = true;
continue;
}

if (gotR)
{
if (data == 10)
break;

ms.WriteByte(13);

gotR = false;
}

ms.WriteByte((byte)data);
}

string retval = Encoding.ASCII.GetString(ms.ToArray(), 0, (int)ms.Length);

if (log.IsDebugEnabled)
log.Debug("ReadLine: " + retval);

return retval;
}

/// <summary>
/// Gets the bytes representing the specified command. returned buffer can be used to streamline multiple writes into one Write on the Socket
/// using the <see cref="M:Enyim.Caching.Memcached.PooledSocket.Write(IList&lt;ArraySegment&lt;byte&gt;&gt;)"/>
/// </summary>
/// <param name="value">The command to be converted.</param>
/// <returns>The buffer containing the bytes representing the command. The command must be terminated by \r\n.</returns>
/// <remarks>The Nagle algorithm is disabled on the socket to speed things up, so it's recommended to convert a command into a buffer
/// and use the <see cref="M:Enyim.Caching.Memcached.PooledSocket.Write(IList&lt;ArraySegment&lt;byte&gt;&gt;)"/> to send the command and the additional buffers in one transaction.</remarks>
public unsafe static IList<ArraySegment<byte>> GetCommandBuffer(string value)
{
var data = new ArraySegment<byte>(Encoding.ASCII.GetBytes(value));

return new ArraySegment<byte>[] { data };
}

public unsafe static IList<ArraySegment<byte>> GetCommandBuffer(string value, IList<ArraySegment<byte>> list)
{
var data = new ArraySegment<byte>(Encoding.ASCII.GetBytes(value));

list.Add(data);

return list;
}

}
}

#region [ License information ]
Expand Down