Core.CorelinkClient Class Reference

Static Public Member Functions
static async Task< bool >	ConnectAsync (string hostName, int port, string username, string password)
static async Task< JObject >	RequestAsync (JObject request, int timeoutMs=15000)
static async Task	DisconnectAsync ()
static async Task< bool >	Connect (string hostName, int port, string username, string password)
	Old connect. Wraps ConnectAsync.
static async Task< string >	Request (string data)
	Old request method. Wraps RequestAsync, returns raw JSON string.
static async Task< string >	CreateSender (string options)
	Old CreateSender. Wraps RequestAsync with sender-specific logic.
static string	GetToken ()
static string	GetClientIp ()
static string	GetEndpoint ()
static async Task< JObject >	KeepAliveAsync ()
static async Task< string[]>	ListFunctionsAsync ()
static async Task< string[]>	ListServerFunctionsAsync ()
static async Task< JObject >	DescribeFunctionAsync (string functionName)
static async Task< JObject >	DescribeServerFunctionAsync (string functionName)
static async Task< string[]>	ListWorkspacesAsync ()
static async Task< JObject >	AddWorkspaceAsync (string workspace)
static async Task< JObject >	SetDefaultWorkspaceAsync (string workspace)
static async Task< string >	GetDefaultWorkspaceAsync ()
static async Task< JObject >	RmWorkspaceAsync (string workspace)
static async Task< JObject >	AddUserAsync (string username, string password, bool? admin=null, string first=null, string last=null, string email=null)
static async Task< JObject >	ChangePasswordAsync (string newPassword)
static async Task< JObject >	RmUserAsync (string username)
static async Task< JObject[]>	ListUsersAsync ()
static async Task< JObject >	AddGroupAsync (string group)
static async Task< JObject >	AddUserGroupAsync (string group, string user)
static async Task< JObject >	RmUserGroupAsync (string group, string user)
static async Task< JObject >	ChangeOwnerAsync (string group, string username)
static async Task< JObject >	RmGroupAsync (string group)
static async Task< string[]>	ListGroupsAsync ()
static async Task< JObject >	SenderAsync (string workspace, string type, string proto="tcp", string ip=null, bool alert=false, string meta="", string from="", string senderID=null)
static async Task< JObject >	ListStreamsAsync (string[] workspaces=null, string[] types=null)
static async Task< JObject >	StreamInfoAsync (string streamID)
static async Task< JObject >	ReceiverAsync (string workspace, string[] streamIDs=null, string proto="tcp", string[] types=null, bool alert=false, bool echo=false, string ip=null, string meta="", string receiverID=null)
static async Task< JObject >	SubscribeAsync (string receiverID, string[] streamIDs)
static async Task< JObject >	SetConfigAsync (string config, string value, string context=null, string app=null, string user=null)
static async Task< JObject >	DisconnectStreamsAsync (string[] workspaces=null, string[] types=null, string[] streamIDs=null)
static async Task< JObject >	ExpireAsync ()

Static Public Attributes
static bool	debug = true
static readonly Dictionary< int, JObject >	senderStreams = new()

Properties
static Action< string, JObject >	OnServerPush [get, set]
static Action< string, string, string, string[], string, string >	OnUpdate [get, set]
static Action< string, string, string, string[], string >	OnSubscriber [get, set]
static Action< string >	OnStale [get, set]
static Action< string >	OnDropped [get, set]

Member Function Documentation

AddGroupAsync()

static async Task< JObject > Core.CorelinkClient.AddGroupAsync ( string group )

inlinestatic

AddUserAsync()

static async Task< JObject > Core.CorelinkClient.AddUserAsync ( string username, string password, bool? admin = null, string first = null, string last = null, string email = null )

inlinestatic

AddUserGroupAsync()

static async Task< JObject > Core.CorelinkClient.AddUserGroupAsync ( string group, string user )

inlinestatic

AddWorkspaceAsync()

static async Task< JObject > Core.CorelinkClient.AddWorkspaceAsync ( string workspace )

inlinestatic

ChangeOwnerAsync()

static async Task< JObject > Core.CorelinkClient.ChangeOwnerAsync ( string group, string username )

inlinestatic

ChangePasswordAsync()

static async Task< JObject > Core.CorelinkClient.ChangePasswordAsync ( string newPassword )

inlinestatic

Connect()

static async Task< bool > Core.CorelinkClient.Connect ( string hostName, int port, string username, string password )

inlinestatic

Old connect. Wraps ConnectAsync.

ConnectAsync()

static async Task< bool > Core.CorelinkClient.ConnectAsync ( string hostName, int port, string username, string password )

inlinestatic

CreateSender()

static async Task< string > Core.CorelinkClient.CreateSender ( string options )

inlinestatic

Old CreateSender. Wraps RequestAsync with sender-specific logic.

DescribeFunctionAsync()

static async Task< JObject > Core.CorelinkClient.DescribeFunctionAsync ( string functionName )

inlinestatic

DescribeServerFunctionAsync()

static async Task< JObject > Core.CorelinkClient.DescribeServerFunctionAsync ( string functionName )

inlinestatic

DisconnectAsync()

static async Task Core.CorelinkClient.DisconnectAsync ( )

inlinestatic

DisconnectStreamsAsync()

static async Task< JObject > Core.CorelinkClient.DisconnectStreamsAsync ( string[] workspaces = null, string[] types = null, string[] streamIDs = null )

inlinestatic

ExpireAsync()

static async Task< JObject > Core.CorelinkClient.ExpireAsync ( )

inlinestatic

GetClientIp()

static string Core.CorelinkClient.GetClientIp ( )

static

GetDefaultWorkspaceAsync()

static async Task< string > Core.CorelinkClient.GetDefaultWorkspaceAsync ( )

inlinestatic

GetEndpoint()

static string Core.CorelinkClient.GetEndpoint ( )

static

GetToken()

static string Core.CorelinkClient.GetToken ( )

static

KeepAliveAsync()

static async Task< JObject > Core.CorelinkClient.KeepAliveAsync ( )

inlinestatic

ListFunctionsAsync()

static async Task< string[]> Core.CorelinkClient.ListFunctionsAsync ( )

inlinestatic

ListGroupsAsync()

static async Task< string[]> Core.CorelinkClient.ListGroupsAsync ( )

inlinestatic

ListServerFunctionsAsync()

static async Task< string[]> Core.CorelinkClient.ListServerFunctionsAsync ( )

inlinestatic

ListStreamsAsync()

static async Task< JObject > Core.CorelinkClient.ListStreamsAsync ( string[] workspaces = null, string[] types = null )

inlinestatic

ListUsersAsync()

static async Task< JObject[]> Core.CorelinkClient.ListUsersAsync ( )

inlinestatic

ListWorkspacesAsync()

static async Task< string[]> Core.CorelinkClient.ListWorkspacesAsync ( )

inlinestatic

ReceiverAsync()

static async Task< JObject > Core.CorelinkClient.ReceiverAsync ( string workspace, string[] streamIDs = null, string proto = "tcp", string[] types = null, bool alert = false, bool echo = false, string ip = null, string meta = "", string receiverID = null )

inlinestatic

Request()

static async Task< string > Core.CorelinkClient.Request ( string data )

inlinestatic

Old request method. Wraps RequestAsync, returns raw JSON string.

RequestAsync()

static async Task< JObject > Core.CorelinkClient.RequestAsync ( JObject request, int timeoutMs = 15000 )

inlinestatic

RmGroupAsync()

static async Task< JObject > Core.CorelinkClient.RmGroupAsync ( string group )

inlinestatic

RmUserAsync()

static async Task< JObject > Core.CorelinkClient.RmUserAsync ( string username )

inlinestatic

RmUserGroupAsync()

static async Task< JObject > Core.CorelinkClient.RmUserGroupAsync ( string group, string user )

inlinestatic

RmWorkspaceAsync()

static async Task< JObject > Core.CorelinkClient.RmWorkspaceAsync ( string workspace )

inlinestatic

SenderAsync()

static async Task< JObject > Core.CorelinkClient.SenderAsync ( string workspace, string type, string proto = "tcp", string ip = null, bool alert = false, string meta = "", string from = "", string senderID = null )

inlinestatic

SetConfigAsync()

static async Task< JObject > Core.CorelinkClient.SetConfigAsync ( string config, string value, string context = null, string app = null, string user = null )

inlinestatic

SetDefaultWorkspaceAsync()

static async Task< JObject > Core.CorelinkClient.SetDefaultWorkspaceAsync ( string workspace )

inlinestatic

StreamInfoAsync()

static async Task< JObject > Core.CorelinkClient.StreamInfoAsync ( string streamID )

inlinestatic

SubscribeAsync()

static async Task< JObject > Core.CorelinkClient.SubscribeAsync ( string receiverID, string[] streamIDs )

inlinestatic

Field Documentation

debug

bool Core.CorelinkClient.debug = true

static

senderStreams

readonly Dictionary<int, JObject> Core.CorelinkClient.senderStreams = new()

static

Property Documentation

OnDropped

Action<string> Core.CorelinkClient.OnDropped

staticgetset

OnServerPush

Action<string, JObject> Core.CorelinkClient.OnServerPush

staticgetset

OnStale

Action<string> Core.CorelinkClient.OnStale

staticgetset

OnSubscriber

Action<string, string, string, string[], string> Core.CorelinkClient.OnSubscriber

staticgetset

OnUpdate

Action<string, string, string, string[], string, string> Core.CorelinkClient.OnUpdate

staticgetset

---

The documentation for this class was generated from the following file:

• csharp/Core/CorelinkClient.cs