FireflyClient

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized resource of type System.Byte[].

FireflyClient provides a clean API for interacting with the Firefly server. This can be used as a library for integrating with other applications.

Creates a new FireflyClient and connects to the specified server

Creates a new FireflyClient, connects to the server and authenticates

Authenticates with the server using the provided password

Executes a raw command with any number of arguments

Enables or disables pipeline mode

Flushes any queued commands in pipeline mode

Sets the maximum number of commands to batch before sending

Gets the current number of queued commands

Gets whether pipeline mode is enabled

Gets the maximum batch size

Gets whether the client is connected to the server

Gets whether the client is authenticated

Gets all keys matching the specified pattern

Pattern to match against keys. Use * for wildcard matches. List of matching keys, or empty list if none found or on error

Parses an array response from the server

Sets a field in a hash

Gets a field from a hash

Deletes a field from a hash

Checks if a field exists in a hash

Gets all fields and values from a hash

Sets multiple fields in a hash at once

Adds values to the beginning of a list

Adds values to the end of a list

Removes and returns the first element of a list

Removes and returns the last element of a list

Gets the length of a list

Gets a range of elements from a list

Gets the element at the specified index in a list

Sets the element at the specified index in a list

Returns the index of the first occurrence of an element in a list

Trims a list to the specified range

Removes elements equal to the given value from a list

String array structure for interop

Pointer to an array of string pointers

Number of strings in the array

Key-value pair structure for interop

Pointer to the key string

Pointer to the value string

Dictionary structure for interop

Pointer to an array of key-value pairs

Number of pairs in the array

Marshals a List to a NativeStringList without string conversion

Marshals a Dictionary to a NativeDictionary without string conversion

Creates a new FireflyClient instance for native interop

Destroys a FireflyClient instance created for native interop

Authenticates with the server using the provided password

Executes a raw command. Note: Argument parsing is basic. Consider using specific functions instead for reliability.

Frees a string allocated by the native interop methods

Frees a NativeStringList allocated by the native interop methods

Frees a NativeDictionary allocated by the native interop methods

Sets a string value for a given key (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the key. Pointer to a null-terminated UTF-8 string representing the value. True if the command was successful (e.g., server replied OK), false otherwise.

Gets a string value for a given key (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the key. Pointer to a null-terminated UTF-8 string result allocated via AllocHGlobal (caller must free with FreeString), or IntPtr.Zero on error or if key not found.

Deletes one or more keys (Native Interop). Note: Currently only supports deleting a single key via the C# Delete method.

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the key to delete. The number of keys that were removed (typically 1 or 0), or 0 on error.

Adds a value to the beginning of a list (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the list key. Pointer to a null-terminated UTF-8 string representing the value to add. The length of the list after the push operation, or 0 on error.

Adds a value to the end of a list (Native Interop).

Removes and returns the first element of a list (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the list key. Pointer to a null-terminated UTF-8 string result allocated via AllocHGlobal (caller must free with FreeString), or IntPtr.Zero on error or if list is empty.

Removes and returns the last element of a list (Native Interop).

Gets the length of a list (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the list key. The length of the list, or 0 on error.

Gets a range of elements from a list (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the list key. The start index (0-based). The stop index (inclusive, use -1 for end). Pointer to a null-terminated UTF-8 string containing newline-delimited list elements, allocated via AllocHGlobal (caller must free with FreeString), or IntPtr.Zero on error. The returned IntPtr points to a single string. The native caller must parse this string (e.g., split by '\n') and free the pointer using NativeFreeString.

Gets an element from a list by its index (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the list key. The index of the element (0-based). Pointer to a null-terminated UTF-8 string result allocated via AllocHGlobal (caller must free with FreeString), or IntPtr.Zero on error or if index is out of range.

Sets the value of an element in a list by its index (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the list key. The index of the element to set (0-based). Pointer to a null-terminated UTF-8 string representing the new value. True if the command was successful, false otherwise (e.g., index out of range).

Returns the index of the first occurrence of an element in a list (Native Interop). Rank and MaxLen parameters are currently ignored.

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the list key. Pointer to a null-terminated UTF-8 string representing the element to find. Optional rank (ignored). Optional max length (ignored). The 0-based index of the element, or -1 if not found or on error.

Trims a list to contain only the specified range of elements (Native Interop).

Removes occurrences of elements from a list (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the list key. Number of occurrences to remove (see C# ListRemove docs). Pointer to a null-terminated UTF-8 string representing the element to remove. The number of elements removed, or 0 on error.

Sets the value of a field within a hash (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the hash key. Pointer to a null-terminated UTF-8 string representing the field name. Pointer to a null-terminated UTF-8 string representing the value to set. True if the field was new or updated successfully, false on error.

Gets the value of a field within a hash (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the hash key. Pointer to a null-terminated UTF-8 string representing the field name. Pointer to a null-terminated UTF-8 string result allocated via AllocHGlobal (caller must free with FreeString), or IntPtr.Zero on error or if field/key not found.

Deletes a field from a hash (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the hash key. Pointer to a null-terminated UTF-8 string representing the field to delete. True if the field was deleted, false otherwise (e.g., field/key not found).

Checks if a field exists within a hash (Native Interop).

Sets multiple fields and values in a hash (Native Interop). Parses a space-separated string of field-value pairs.

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the hash key. Pointer to a null-terminated UTF-8 string of space-separated field-value pairs. True if successful, false on error (e.g., odd number of pairs).

Gets all fields and values from a hash (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the hash key. Pointer to a null-terminated UTF-8 string containing newline-delimited "field=value" pairs, allocated via AllocHGlobal (caller must free with FreeString), or IntPtr.Zero on error or if hash not found. The returned IntPtr points to a single string. The native caller must parse this string (e.g., split by '\n', then by '=') and free the pointer using NativeFreeString.

Enables or disables pipeline mode for the client (Native Interop).

The GCHandle (as IntPtr) representing the client instance. True to enable pipeline mode, false to disable. True if the mode was set successfully, false on error.

Sets the maximum number of commands to batch in pipeline mode (Native Interop).

The GCHandle (as IntPtr) representing the client instance. The maximum number of commands to queue before sending. True if the batch size was set successfully, false on error (e.g., invalid size).

Sends all queued commands to the server immediately (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string containing the server's combined response, allocated via AllocHGlobal (caller must free with FreeString), or IntPtr.Zero on error or if queue was empty.

Gets the number of commands currently waiting in the pipeline queue (Native Interop).

The GCHandle (as IntPtr) representing the client instance. The number of queued commands, or 0 on error.

Checks if pipeline mode is currently enabled for the client (Native Interop).

The GCHandle (as IntPtr) representing the client instance. True if pipeline mode is enabled, false otherwise or on error.

Gets the current maximum batch size configured for pipeline mode (Native Interop).

The GCHandle (as IntPtr) representing the client instance. The maximum batch size, or 0 on error.

Gets all keys matching the specified pattern (Native Interop).

The GCHandle (as IntPtr) representing the client instance. Pointer to a null-terminated UTF-8 string representing the pattern to match against keys. Pointer to a null-terminated UTF-8 string containing newline-delimited keys, allocated via AllocHGlobal (caller must free with FreeString), or IntPtr.Zero on error.

Sets a key-value pair

Gets a value by key

Deletes a key from all stores (string, list, hash)

Command-line interface for Firefly