friflo / fliox-docs

JSON Fliox - API Reference

   fliox-docs API Reference

This project contains the API Reference of the JSON Fliox library.
Following sections list fundamental Friflo.Json.Fliox.Hub.* classes grouped by their use case.
These groups fit mainly to their namespaces. Except .Remote containing client as well server classes.

Client

Example client Todo/Client/TodoClient.cs and client utilization Todo/Test/Trial.cs

Namespace	Class	Description
.Client	FlioxClient	FlioxClient subclasses are used as database clients and database schema
.Client	EntitySet<,>	Strongly typed API to a access a database container used as property in a FlioxClient subclass
.Remote	HttpClientHub	Connects to a Hub via HTTP by passing it to a FlioxClient constructor
.Remote	WebSocketClientHub	Connects to a Hub via Websocket by passing it to a FlioxClient constructor

Host

HTTP Hub bootstrapping examples Todo/Hub/Program.cs and Demo/Hub/Program.cs

Namespace	Class	Description
.Remote	HttpHost	Host a FlioxHub as HTTP / WebSocket server
.Remote	StaticFileHandler	Add static web files to the HttpHost like the Hub Explorer
.Host	FlioxHub	Used as a Proxy between a FlioxClient and a concrete database
.Host	FileDatabase	Database storing records in the file-system
.Host	MemoryDatabase	Database storing records in-memory
.Host	DatabaseSchema	Used to assign a schema to a database
.Host	DatabaseService	Used to implement custom database commands declared in a FlioxClient subclass
.Host.Event	EventDispatcher	Enables Pub-Sub by a FlioxHub

DB

Adding support databases example Demo/Hub/Program.cs

Namespace	Class	Description
.DB.Cluster	ClusterDB	Expose information of hosted databases as a database
.DB.Monitor	MonitorDB	Expose request information of a FlioxHub as a database
.DB.UserAuth	UserAuthenticator	Performs user authentication and authorization