Skip to content

Commit 217b3d3

Browse files
gefjondbrinkmanncwDerek Brinkmann
authored
Add support for client address; re-run spacetime generate for quickstart client (#54)
* README.md and License.txt updates (#53) * Update README.md * Add license.txt * Rename * Add LICENSE.txt with proper case --------- Co-authored-by: Derek Brinkmann <[email protected]> * Add support for client address; re-run `spacetime generate` for quickstart client Re: clockworklabs/SpacetimeDB#299 --------- Co-authored-by: dbrinkmanncw <[email protected]> Co-authored-by: Derek Brinkmann <[email protected]>
1 parent a9e4c54 commit 217b3d3

File tree

12 files changed

+545
-62
lines changed

12 files changed

+545
-62
lines changed

‎LICENSE.txt‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 132 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,142 @@
11
# SpacetimeDB SDK for C#
22

3-
The SpacetimeDB SDK is a software development kit (SDK) designed to simplify the interaction with SpacetimeDB server modules.
3+
## Overview
44

5-
## Key Features
5+
This repository contains the [C#](https://learn.microsoft.com/en-us/dotnet/csharp/) SDK for SpacetimeDB. The SDK allows to interact with the database server and is prepared to work with code generated from a SpacetimeDB backend code.
66

7-
### Connection Management
7+
## Documentation
88

9-
The SDK simplifies the process of establishing and managing connections to the SpacetimeDB module. Developers can establish secure WebSocket connections, enabling real-time communication with the module.
9+
The C# SDK has a [Quick Start](https://spacetimedb.com/docs/client-languages/csharp/csharp-sdk-quickstart-guide) guide and a [Reference](https://spacetimedb.com/docs/client-languages/csharp/csharp-sdk-reference).
1010

11-
### Local Client Cache
11+
## Installation
1212

13-
By subscribing to a set of queries, the SDK will keep a local cache of rows that match the subscribed queries. SpacetimeDB generates C# files that allow you to iterate throught these tables and filter on specific columns.
13+
The SDK is available as a [NuGet Package](https://www.nuget.org/packages/SpacetimeDB.ClientSDK). To install it, follow these steps:
1414

15-
### Transaction and Row Update Events
15+
1. Open the NuGet package manager in Visual Studio.
16+
2. Search for `SpacetimeDB.ClientSDK`.
17+
3. Click the install button.
18+
19+
Alternatively, it can be installed on the command line using the `dotnet` command:
20+
21+
```bash
22+
dotnet add package SpacetimeDB.ClientSDK
23+
```
24+
25+
## Usage
26+
27+
### Create the SpacetimeDB Client
28+
29+
To create a SpacetimeDB client, you need to create an instance of the `SpacetimeDBClient` class. The `SpacetimeDBClient` constructor takes the `module_bindings` folder that contains the auto-generated files as a parameter. The `module_bindings` folder is generated by the CLI generate command.
30+
31+
```csharp
32+
using SpacetimeDB;
33+
34+
// create the client, pass in a logger to see debug messages
35+
SpacetimeDBClient.CreateInstance(new ConsoleLogger());
36+
```
37+
38+
### Connecting to SpacetimeDB
39+
40+
To connect to SpacetimeDB, you need to call the `Connect` method on the `SpacetimeDBClient` class. The `Connect` method takes the following parameters:
41+
42+
- `token`: The authentication token to use to connect to SpacetimeDB. This token is generated by the backend code and is used to authenticate the client.
43+
- `hostName`: The hostname of the SpacetimeDB server. This is the same hostname that you use to connect to the SpacetimeDB web interface.
44+
- `moduleAddress`: The address of the module to connect to. This is the same address that you use to connect to the SpacetimeDB web interface.
45+
- `sslEnabled`: Whether to use SSL to connect to SpacetimeDB. This is the same value that you use to connect to the SpacetimeDB web interface.
46+
47+
Example:
48+
49+
```csharp
50+
using SpacetimeDB;
51+
52+
SpacetimeDBClient.instance.Connect(TOKEN, HOST, DBNAME, SSL_ENABLED);
53+
```
54+
55+
### AuthToken optional helper class
56+
57+
The `AuthToken` class is a helper class that can be used to store the local client's authentication token locally to your user's home directory.
58+
59+
```csharp
60+
using SpacetimeDB;
61+
62+
AuthToken.Init(".spacetime_csharp_quickstart");
63+
64+
SpacetimeDBClient.instance.Connect(AuthToken.Token, HOST, DBNAME, SSL_ENABLED);
65+
66+
void OnIdentityReceived(string authToken, Identity identity)
67+
{
68+
local_identity = identity;
69+
AuthToken.SaveToken(authToken);
70+
}
71+
SpacetimeDBClient.instance.onIdentityReceived += OnIdentityReceived;
72+
```
73+
74+
### Subscribing to tables
75+
76+
To subscribe to a table, you need to call the `Subscribe` method on the `SpacetimeDBClient` class. The `Subscribe` method takes a list of queries as a parameter. The queries are the same queries that you use to subscribe to tables in the SpacetimeDB web interface.
77+
78+
### Listening to events
79+
80+
To listen to events, you need to register callbacks on the `SpacetimeDBClient` class. The following callbacks are available:
81+
82+
- `onConnect`: Called when the client connects to SpacetimeDB.
83+
- `onConnectError`: Called when the client fails to connect to SpacetimeDB.
84+
- `onDisconnect`: Called when the client disconnects from SpacetimeDB.
85+
- `onIdentityReceived`: Called when the client receives its identity from SpacetimeDB.
86+
- `onSubscriptionApplied`: Called when the client receives the initial data from SpacetimeDB after subscribing to tables.
87+
88+
You can register for row update events on a table. To do this, you need to register callbacks on the table class. The following callbacks are available:
89+
90+
- `OnInsert`: Called when a row is inserted into the table.
91+
- `OnUpdate`: Called when a row is updated in the table.
92+
- `OnBeforeDelete`: Called before a row is deleted from the table.
93+
- `OnDelete`: Called when a row is deleted from the table.
94+
- `OnRowUpdate`: Called when a row is inserted, updated, or deleted from the table.
95+
96+
Example:
97+
98+
```csharp
99+
using SpacetimeDB.Types;
100+
101+
PlayerComponent.OnInsert += PlayerComponent_OnInsert;
102+
PlayerComponent.OnUpdate += PlayerComponent_OnUpdate;
103+
PlayerComponent.OnDelete += PlayerComponent_OnDelete;
104+
PlayerComponent.OnBeforeDelete += PlayerComponent_OnBeforeDelete;
105+
PlayerComponent.OnRowUpdate += PlayerComponent_OnRowUpdate;
106+
```
107+
108+
You can register for reducer call updates as well.
109+
110+
- `OnREDUCEREvent`: Called when a reducer call is received from SpacetimeDB. (If a) you are subscribed to the table that the reducer modifies or b) You called the reducer and it failed)
111+
112+
Example:
113+
114+
```csharp
115+
using SpacetimeDB.Types;
116+
117+
Reducer.OnMovePlayerEvent += Reducer_OnMovePlayerEvent;
118+
```
119+
120+
### Accessing the client cache
121+
122+
The client cache is a local cache of the data that the client has received from SpacetimeDB. The client cache is automatically updated when the client receives updates from SpacetimeDB.
123+
124+
When you run the CLI generate command, SpacetimeDB will automatically generate a class for each table in your database. These classes are generated in the `SpacetimeDB.Types` namespace. Each class contains a set of static methods that allow you to query the client cache. The following methods are available:
125+
126+
- `FilterByCOLUMN`: Filters the table by the specified column value.
127+
- `Iter`: Returns an iterator over the table.
128+
- `Count`: Returns the number of rows in the table.
129+
130+
### Calling Reducers
131+
132+
To call a reducer, you need to call the autogenerated method on the `Reducer` class. The autogenerated method takes the reducer arguments as parameters. The reducer arguments are the same arguments that are expected in your server module.
133+
134+
Example:
135+
136+
```csharp
137+
using SpacetimeDB.Types;
138+
139+
Reducer.MovePlayer(new StdbVector2(0.0f, 0.0f), new StdbVector2(1.0f, 1.0f));
140+
```
16141

17-
Register for transaction and row update events.
18142

19-
Full documentation can be found on the [SpacetimeDB](spacetimedb.com) website.

‎examples/quickstart/client/Program.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ void OnConnect()
113113
SpacetimeDBClient.instance.Subscribe(new List<string> { "SELECT * FROM User", "SELECT * FROM Message" });
114114
}
115115

116-
void OnIdentityReceived(string authToken, Identity identity)
116+
void OnIdentityReceived(string authToken, Identity identity, Address clientAddress)
117117
{
118118
local_identity = identity;
119119
AuthToken.SaveToken(authToken);
@@ -192,4 +192,4 @@ void ProcessCommands()
192192
}
193193
}
194194

195-
Main();
195+
Main();

‎examples/quickstart/client/module_bindings/ReducerEvent.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ public partial class ReducerEvent : ReducerEventBase
1919
{
2020
public ReducerType Reducer { get; private set; }
2121

22-
public ReducerEvent(ReducerType reducer, string reducerName, ulong timestamp, SpacetimeDB.Identity identity, string errMessage, ClientApi.Event.Types.Status status, object args)
23-
: base(reducerName, timestamp, identity, errMessage, status, args)
22+
public ReducerEvent(ReducerType reducer, string reducerName, ulong timestamp, SpacetimeDB.Identity identity, SpacetimeDB.Address? callerAddress, string errMessage, ClientApi.Event.Types.Status status, object args)
23+
: base(reducerName, timestamp, identity, callerAddress, errMessage, status, args)
2424
{
2525
Reducer = reducer;
2626
}

‎examples/quickstart/client/module_bindings/ReducerJsonSettings.cs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
using SpacetimeDB;
2+
3+
namespace SpacetimeDB.Types
4+
{
5+
public partial class Reducer
6+
{
7+
private static Newtonsoft.Json.JsonSerializerSettings _settings = new Newtonsoft.Json.JsonSerializerSettings
8+
{
9+
Converters = { new SpacetimeDB.SomeWrapperConverter(), new SpacetimeDB.EnumWrapperConverter() },
10+
ContractResolver = new SpacetimeDB.JsonContractResolver(),
11+
};
12+
}
13+
}

0 commit comments

Comments
 (0)