C# Client 0.0.0.7
C# Library to interface with Corelink
|
CCoreLink.Config | The Config class is filled once at the beginning of the unity session and contains important server information |
CCoreLink.Control | Singleton class to communicate with Corelink |
▼CCoreLink.ControlStream | Abstract 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 |
CCoreLink.CorelinkTCP | This class was used as the control connection which will be deprecated soon in favor of WebSockets |
CCoreLink.CorelinkWebSocket | |
CCoreLink.CorelinkParser | This class is a purely static utility class that contains helper functions for CoreLink data parsing |
CCoreLink.CorelinkUDP | Client to send and receive data to/from CoreLink via UDP |
CCoreLink.Credentials | Contains 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 |
▼CException | |
CCoreLink.CorelinkException | |
▼CMonoBehaviour | |
CCoreLink.ReceiverStream | Parent 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 |
CCoreLink.SenderStream | Parent class to custom sender scripts that will be attached to GameObjects. Several of these can be instantiated. Use Send(streamID, data) to send data |
CCorelinkGM | |
▼CSystem.Object | |
CCoreLink.UdpState | Utility class for asynchronous data receiving |
CCoreLink.StreamFilter | When 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 |
▼CCoreLink.StreamParams | Parent class of Receiver/SenderStreamParams with shared information |
CCoreLink.ReceiverStreamParams | |
CCoreLink.SenderStreamParams | Contains all the necessary parameters for sender streams except IP and port. Inherits from StreamParams |
CCorelink.TransformPasser | This class is a utility class to serialize the unity Transform class in order to pass/retrieve to/from corelink |
CCoreLink.UDPHeader | Header for a UDP packet to Corelink. Contains the streamID and timestamp in milliseconds since the Unix Epoch |