https://github.com/catalystcode/3dtoolkit-server-store
Maintains state around the VMs deployed to serve 3dtoolkit streams
https://github.com/catalystcode/3dtoolkit-server-store
Last synced: 10 months ago
JSON representation
Maintains state around the VMs deployed to serve 3dtoolkit streams
- Host: GitHub
- URL: https://github.com/catalystcode/3dtoolkit-server-store
- Owner: CatalystCode
- License: other
- Created: 2018-05-10T19:22:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-10T19:28:36.000Z (over 7 years ago)
- Last Synced: 2025-01-22T15:48:01.168Z (11 months ago)
- Language: JavaScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# server-store
[](https://travis-ci.com/CatalystCode/3dtoolkit-server-store)
A module used by the orchestration service of the [3dtoolkit](https://github.com/CatalystCode/3dtoolkit) to managed the shared state around active vms handing webrtc servers.
## Installation
```
$ npm install --save 3dtoolkit-server-store
```
## Initialization
The module exposes a class, ServerStore. Instances of this class requires initialization to setup the database client via the init method with the options below. Only cosmosDbEndpoint and cosmosDbKey are required, the others, if not provided, will default to the values below.
```
let serverStore = new ServerStore();
let options = {
cosmosDbEndpoint: ,
cosmosDbKey: ,
databaseName: , // defaults to '3dtoolkit'
collectionName: , // defaults to 'servers'
collectionRUs: <# of request units to provision for collection> // defaults to 1000
};
serverStore.init(options, err => {
// ... perform actions on serverStore per below
});
```
## serverStore.upsert(server, callback)
You can upsert servers into the store via 'upsert'. If a server exists it will be updated, otherwise it will be inserted.
```
// server is of the form { serverId: "...", azureServerId: "...", turnServerId: "..." }
serverStore.upsert(server, err => {
// server has been upserted.
});
```
## serverStore.delete(serverId, callback)
Deletes a server from the store.
```
serverStore.delete(serverId, err => {
// server has been deleted.
}
```
## getByServerId(serverId, callback)
Gets a server's entry by server id.
```
serverStore.getByServerId((err, servers => {
// servers is an array of server entries
})
```
More usage details can be found in the unit tests.