C# Client 0.0.0.7
C# Library to interface with Corelink
Loading...
Searching...
No Matches
Package List
Here are the packages with brief descriptions (if available):
[detail level 12]
 NCoreLink
 CConfigThe Config class is filled once at the beginning of the unity session and contains important server information
 CControlSingleton class to communicate with Corelink
 CControlStreamAbstract class for a control stream that contains the function prototypes for the server callback functions. Inherited by CorelinkTCP and CorelinkWebSocket. CorelinkWebSocket must have a child class called ControlCallBacks that can override these server callback functions
 CCorelinkException
 CCorelinkParserThis class is a purely static utility class that contains helper functions for CoreLink data parsing
 CCorelinkTCPThis class was used as the control connection which will be deprecated soon in favor of WebSockets
 CCorelinkUDPClient to send and receive data to/from CoreLink via UDP
 CCorelinkWebSocket
 CCredentialsContains user information to authenticate with Corelink. The username and password are sent to the server and authenticated, and then the server returns a token which must be used throughout the app's life to authenticate every function request
 CReceiverStreamParent class to custom receiver scripts that will be attached to GameObjects. Several of these can be instantiated, and each of them will have their own sender stream. OnMessage(streamID, data) is called whenever there is data See the README for caveats on multiple receiver streams
 CReceiverStreamParams
 CSenderStreamParent class to custom sender scripts that will be attached to GameObjects. Several of these can be instantiated. Use Send(streamID, data) to send data
 CSenderStreamParamsContains all the necessary parameters for sender streams except IP and port. Inherits from StreamParams
 CStreamFilterWhen creating a receiver stream, the request must query what workspace and type of stream to receive from. This class is a wrapper to create a filter to create receiver streams. At least 1 workspace and 1 type are required. Streamids can be left blank
 CStreamParamsParent class of Receiver/SenderStreamParams with shared information
 CUDPHeaderHeader for a UDP packet to Corelink. Contains the streamID and timestamp in milliseconds since the Unix Epoch
 CUdpStateUtility class for asynchronous data receiving
 NCorelink
 CTransformPasserThis class is a utility class to serialize the unity Transform class in order to pass/retrieve to/from corelink