rtyler
/
memcache-ada
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Re-namespace to Memcache.Client

This commit is contained in:
R. Tyler Croy 2011-03-27 10:32:56 -07:00
parent 0944d63c04
commit c62f897803
6 changed files with 252 additions and 249 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/memcache-contains_string.adb → src/memcache-client-contains_string.adb
View File

@ -1,4 +1,4 @@
separate (Memcache)
separate (Memcache.Client)
function Contains_String (Haystack : in SU.Unbounded_String;
Needle : in String) return Boolean is
R_Length : constant Natural := SU.Length (Haystack);

8
src/memcache-read_get_response.adb → src/memcache-client-read_get_response.adb
View File

@ -1,8 +1,8 @@
private with GNAT.Sockets;
private with GNAT.String_Split;
private with Ada.Streams;
with GNAT.Sockets;
with GNAT.String_Split;
with Ada.Streams;
separate (Memcache)
separate (Memcache.Client)
function Read_Get_Response (Conn : in Connection) return Response is
use GNAT.Sockets;
use GNAT.String_Split;

2
src/memcache-validate.adb → src/memcache-client-validate.adb
View File

@ -1,4 +1,4 @@
separate (Memcache)
separate (Memcache.Client)
procedure Validate (Key : in String) is
begin
-- A key must be between 1 and 250 characters in length

4
src/memcache.adb → src/memcache-client.adb
View File

@ -9,7 +9,7 @@ private with GNAT.String_Split;
use type Ada.Streams.Stream_Element_Count;
use type Ada.Calendar.Time;
package body Memcache is
package body Memcache.Client is
function Create (Host : in String; Port : in Port_Type)
return Connection is
C : Connection;
@ -485,5 +485,5 @@ package body Memcache is
begin
return Input & CRLF;
end Append_CRLF;
end Memcache;
end Memcache.Client;

244
src/memcache-client.ads Normal file
View File

@ -0,0 +1,244 @@
--
-- Primary Ada Memcached client specification
--
-- This package defines the core API accessible by
-- users of this library
--
with Ada.Calendar;
with Ada.Strings.Unbounded;
with GNAT.Sockets;
private with Ada.Characters.Latin_1;
package Memcache.Client is
package SU renames Ada.Strings.Unbounded;
use type SU.Unbounded_String;
--
-- When passing an expiration, it must be within this range
-- otherwise the server will treat it as a unix timestamp
subtype Expiration is Duration range 0.0 .. 2592000.0;
subtype Port_Type is GNAT.Sockets.Port_Type;
type Flags_Type is mod 2 ** 16;
type Response is record
Flags : Flags_Type;
Data : SU.Unbounded_String;
end record;
--
-- Exceptions that could be raised by the public methods defined in
-- memcache.adb
Invalid_Key_Error : exception;
Unexpected_Response : exception;
Invalid_Connection : exception;
Not_Implemented : exception;
Not_Connected : exception;
type Connection is tagged private;
--
-- `Get` a key's value in the form of a `Response` record, which contains
-- the Flags and the value "data" inside the `Data` member. The end-user
-- is responsible for parsing that into whatever format makes the most
-- sense
function Get (This : in Connection; Key : in String)
return Response;
--
-- `Set` a key-value pair in memcached, if no `Expire` parameter is passed
-- along with the call then the server will cache the key
-- "indefinitely" (in effect, until the server is shut down or
-- starts to run out of memory to cache other items
function Set (This : in Connection;
Key : in String;
Value : in String;
Flags : in Flags_Type := 0;
Expire : in Expiration := 0.0)
return Boolean;
procedure Set (This : in Connection;
Key : in String;
Value : in String;
Flags : in Flags_Type := 0;
Expire : in Expiration := 0.0);
function Set (This : in Connection;
Key : in String;
Value : in String;
Flags : in Flags_Type := 0;
Expire : in Ada.Calendar.Time)
return Boolean;
--
-- `Delete` a key-value pair in memcached, with an optional `Delayed`
-- parameter which instructs the server to delete after either
-- N seconds (in case of an `Expiration` or at the specified
-- unix timestamp in case of an `Ada.Calendar.Time`
--
-- The `Success` out parameter will indicate `True` if the value was
-- deleted, if the value does not exist however it will
-- indicate `False`
procedure Delete (This : in Connection; Key : in String;
Delayed : in Expiration := 0.0);
procedure Delete (This : in Connection; Key : in String;
Delayed : in Expiration := 0.0;
Success : out Boolean);
procedure Delete (This : in Connection; Key : in String;
Delayed : in Ada.Calendar.Time);
procedure Delete (This : in Connection; Key : in String;
Delayed : in Ada.Calendar.Time;
Success : out Boolean);
--
-- `Increment` the value for a key in memcached, the server will assume
-- the type of the value to be a 64-bit integer and increment it the
-- desired `Value` passed
procedure Increment (This : in Connection;
Key : in String;
Value : in Natural);
procedure Increment (This : in Connection;
Key : in String;
Value : in Natural;
Result : out Natural);
--
-- Functions/procedures implementing the "decr" memcached
-- command
procedure Decrement (This : in Connection;
Key : in String;
Value : in Natural);
procedure Decrement (This : in Connection;
Key : in String;
Value : in Natural;
Result : out Natural);
--
-- The `Flush_All` method will mark **all** items in the memcached server
-- as expired, effectively flushing all items cached
procedure Flush_All (This : in Connection);
--
-- `Version` will return the version string the server responds with
function Version (This : in Connection) return String;
--
-- Stats from the memcached server come back in a relatively
-- unstructured format, so this function will just dump to stdout
procedure Dump_Stats (This : in Connection);
function Create (Host : in String; Port : in Port_Type)
return Connection;
procedure Connect (Conn : in out Connection);
procedure Disconnect (Conn : in out Connection);
private
Response_Stored : constant String := "STORED";
Response_Deleted : constant String := "DELETED";
Response_Not_Found : constant String := "NOT_FOUND";
Epoch : constant Ada.Calendar.Time :=
Ada.Calendar.Time_Of (1970, 1, 1);
type Store_Commands is (Set, Add, Replace, Append, Prepend);
CRLF : constant String := Ada.Characters.Latin_1.CR &
Ada.Characters.Latin_1.LF;
Unbounded_No_Reply : constant SU.Unbounded_String :=
SU.To_Unbounded_String (" noreply");
Flush_All_Command : constant String :=
"flush_all noreply" & CRLF;
Version_Command : constant String := "version" & CRLF;
type Connection is tagged record
Sock : GNAT.Sockets.Socket_Type;
Address : GNAT.Sockets.Sock_Addr_Type;
Connected : Boolean := False;
end record;
--
-- Validation functionsto ensure that a few basic
-- conditions are met:
-- * No spaces in keys
-- * Key length is less than or equal to 250 characters
-- * Key length is greater than zero characters
procedure Validate (Key : in String);
--
-- Verify that our Connection object has not been previously
-- disconnected, will raise `Not_Connected` if it has
procedure Is_Connected (C : in Connection);
--
-- Internal procedure to actually execute a deletion command and check for
-- the expected results on the wire
procedure Exec_Delete (This : in Connection;
Command : in String;
Success : out Boolean);
--
-- Generation functions, used to generate the actual text
-- representations of commands to be sent over the wire to
-- the memcached server
function Generate_Delete (Key : in String;
Delayed : in Natural;
No_Reply : in Boolean) return String;
function Generate_Delete (Key : in String;
Delayed : in Expiration;
No_Reply : in Boolean) return String;
function Generate_Delete (Key : in String;
Delayed : in Ada.Calendar.Time;
No_Reply : in Boolean) return String;
function Generate_Incr (Key : in String; Value : in Natural;
No_Reply : in Boolean) return String;
function Generate_Decr (Key : in String; Value : in Natural;
No_Reply : in Boolean) return String;
function Generate_Store (Kind : in Store_Commands;
Key : in String;
Value : in String;
Flags : in Flags_Type;
Expire : in Natural;
No_Reply : in Boolean) return String;
function Generate_Store (Kind : in Store_Commands;
Key : in String;
Value : in String;
Flags : in Flags_Type;
Expire : in Expiration;
No_Reply : in Boolean) return String;
function Generate_Store (Kind : in Store_Commands;
Key : in String;
Value : in String;
Flags : in Flags_Type;
Expire : in Ada.Calendar.Time;
No_Reply : in Boolean) return String;
function Generate_Get (Key : in String) return String;
procedure Write_Command (Conn : in Connection; Command : in String);
function Read_Until (Conn : in Connection; Terminator : in String;
Trim_CRLF : in Boolean := True)
return String;
function Read_Response (Conn : in Connection) return String;
function Read_Get_Response (Conn : in Connection) return Response;
function Contains_String (Haystack : in SU.Unbounded_String;
Needle : in String) return Boolean;
--
-- Append a \r\n on to the Input string
function Append_CRLF (Input : in String) return String;
end Memcache.Client;

241
src/memcache.ads
View File

@ -1,244 +1,3 @@
--
-- Primary Ada Memcached client specification
--
-- This package defines the core API accessible by
-- users of this library
--
with Ada.Calendar;
with Ada.Strings.Unbounded;
with GNAT.Sockets;
private with Ada.Characters.Latin_1;
package Memcache is
package SU renames Ada.Strings.Unbounded;
use type SU.Unbounded_String;
--
-- When passing an expiration, it must be within this range
-- otherwise the server will treat it as a unix timestamp
subtype Expiration is Duration range 0.0 .. 2592000.0;
subtype Port_Type is GNAT.Sockets.Port_Type;
type Flags_Type is mod 2 ** 16;
type Response is record
Flags : Flags_Type;
Data : SU.Unbounded_String;
end record;
--
-- Exceptions that could be raised by the public methods defined in
-- memcache.adb
Invalid_Key_Error : exception;
Unexpected_Response : exception;
Invalid_Connection : exception;
Not_Implemented : exception;
Not_Connected : exception;
type Connection is tagged private;
--
-- `Get` a key's value in the form of a `Response` record, which contains
-- the Flags and the value "data" inside the `Data` member. The end-user
-- is responsible for parsing that into whatever format makes the most
-- sense
function Get (This : in Connection; Key : in String)
return Response;
--
-- `Set` a key-value pair in memcached, if no `Expire` parameter is passed
-- along with the call then the server will cache the key
-- "indefinitely" (in effect, until the server is shut down or
-- starts to run out of memory to cache other items
function Set (This : in Connection;
Key : in String;
Value : in String;
Flags : in Flags_Type := 0;
Expire : in Expiration := 0.0)
return Boolean;
procedure Set (This : in Connection;
Key : in String;
Value : in String;
Flags : in Flags_Type := 0;
Expire : in Expiration := 0.0);
function Set (This : in Connection;
Key : in String;
Value : in String;
Flags : in Flags_Type := 0;
Expire : in Ada.Calendar.Time)
return Boolean;
--
-- `Delete` a key-value pair in memcached, with an optional `Delayed`
-- parameter which instructs the server to delete after either
-- N seconds (in case of an `Expiration` or at the specified
-- unix timestamp in case of an `Ada.Calendar.Time`
--
-- The `Success` out parameter will indicate `True` if the value was
-- deleted, if the value does not exist however it will
-- indicate `False`
procedure Delete (This : in Connection; Key : in String;
Delayed : in Expiration := 0.0);
procedure Delete (This : in Connection; Key : in String;
Delayed : in Expiration := 0.0;
Success : out Boolean);
procedure Delete (This : in Connection; Key : in String;
Delayed : in Ada.Calendar.Time);
procedure Delete (This : in Connection; Key : in String;
Delayed : in Ada.Calendar.Time;
Success : out Boolean);
--
-- `Increment` the value for a key in memcached, the server will assume
-- the type of the value to be a 64-bit integer and increment it the
-- desired `Value` passed
procedure Increment (This : in Connection;
Key : in String;
Value : in Natural);
procedure Increment (This : in Connection;
Key : in String;
Value : in Natural;
Result : out Natural);
--
-- Functions/procedures implementing the "decr" memcached
-- command
procedure Decrement (This : in Connection;
Key : in String;
Value : in Natural);
procedure Decrement (This : in Connection;
Key : in String;
Value : in Natural;
Result : out Natural);
--
-- The `Flush_All` method will mark **all** items in the memcached server
-- as expired, effectively flushing all items cached
procedure Flush_All (This : in Connection);
--
-- `Version` will return the version string the server responds with
function Version (This : in Connection) return String;
--
-- Stats from the memcached server come back in a relatively
-- unstructured format, so this function will just dump to stdout
procedure Dump_Stats (This : in Connection);
function Create (Host : in String; Port : in Port_Type)
return Connection;
procedure Connect (Conn : in out Connection);
procedure Disconnect (Conn : in out Connection);
private
Response_Stored : constant String := "STORED";
Response_Deleted : constant String := "DELETED";
Response_Not_Found : constant String := "NOT_FOUND";
Epoch : constant Ada.Calendar.Time :=
Ada.Calendar.Time_Of (1970, 1, 1);
type Store_Commands is (Set, Add, Replace, Append, Prepend);
CRLF : constant String := Ada.Characters.Latin_1.CR &
Ada.Characters.Latin_1.LF;
Unbounded_No_Reply : constant SU.Unbounded_String :=
SU.To_Unbounded_String (" noreply");
Flush_All_Command : constant String :=
"flush_all noreply" & CRLF;
Version_Command : constant String := "version" & CRLF;
type Connection is tagged record
Sock : GNAT.Sockets.Socket_Type;
Address : GNAT.Sockets.Sock_Addr_Type;
Connected : Boolean := False;
end record;
--
-- Validation functionsto ensure that a few basic
-- conditions are met:
-- * No spaces in keys
-- * Key length is less than or equal to 250 characters
-- * Key length is greater than zero characters
procedure Validate (Key : in String);
--
-- Verify that our Connection object has not been previously
-- disconnected, will raise `Not_Connected` if it has
procedure Is_Connected (C : in Connection);
--
-- Internal procedure to actually execute a deletion command and check for
-- the expected results on the wire
procedure Exec_Delete (This : in Connection;
Command : in String;
Success : out Boolean);
--
-- Generation functions, used to generate the actual text
-- representations of commands to be sent over the wire to
-- the memcached server
function Generate_Delete (Key : in String;
Delayed : in Natural;
No_Reply : in Boolean) return String;
function Generate_Delete (Key : in String;
Delayed : in Expiration;
No_Reply : in Boolean) return String;
function Generate_Delete (Key : in String;
Delayed : in Ada.Calendar.Time;
No_Reply : in Boolean) return String;
function Generate_Incr (Key : in String; Value : in Natural;
No_Reply : in Boolean) return String;
function Generate_Decr (Key : in String; Value : in Natural;
No_Reply : in Boolean) return String;
function Generate_Store (Kind : in Store_Commands;
Key : in String;
Value : in String;
Flags : in Flags_Type;
Expire : in Natural;
No_Reply : in Boolean) return String;
function Generate_Store (Kind : in Store_Commands;
Key : in String;
Value : in String;
Flags : in Flags_Type;
Expire : in Expiration;
No_Reply : in Boolean) return String;
function Generate_Store (Kind : in Store_Commands;
Key : in String;
Value : in String;
Flags : in Flags_Type;
Expire : in Ada.Calendar.Time;
No_Reply : in Boolean) return String;
function Generate_Get (Key : in String) return String;
procedure Write_Command (Conn : in Connection; Command : in String);
function Read_Until (Conn : in Connection; Terminator : in String;
Trim_CRLF : in Boolean := True)
return String;
function Read_Response (Conn : in Connection) return String;
function Read_Get_Response (Conn : in Connection) return Response;
function Contains_String (Haystack : in SU.Unbounded_String;
Needle : in String) return Boolean;
--
-- Append a \r\n on to the Input string
function Append_CRLF (Input : in String) return String;
end Memcache;