Meteor-Unity  3
A C#-based SDK for connecting Unity to Meteor servers
Static Public Member Functions | Properties | Events | List of all members
Meteor.Connection Class Reference

Manages your Meteor connection. More...

Static Public Member Functions

static Coroutine Connect (string url)
 Connects to the specified URL. Note, Meteor hosted sites do NOT support More...
 
static Coroutine Reconnect ()
 Reconnect to the server. This is useful to call in an OnApplicationPause(bool pause) when pause is false (resuming) More...
 

Properties

static string Url [get, set]
 The URL to connect to. Note, Meteor hosted sites do NOT support More...
 
static bool Logging [get, set]
 Should logging of all messages be enabled for this connection? More...
 
static bool Connected [get]
 Gets a value indicating whether you have successfully connected to the Meteor server. More...
 

Events

static Action DidConnect
 Raised when we succcessfully connect. More...
 

Detailed Description

Manages your Meteor connection.

Member Function Documentation

static Coroutine Meteor.Connection.Connect ( string  url)
inlinestatic

Connects to the specified URL. Note, Meteor hosted sites do NOT support

wss (secured Webscokets) protocols, while Modulus hosted sites do.

Examples:

yield return Meteor.Connection.Connect("ws://localhost:3000/websocket");
yield return Meteor.Connection.Connect("wss://yourmeteorapp.com/websocket");
yield return Meteor.Connection.Connect("ws://yourexampleapp.meteor.com/websocket");
Parameters
urlURL.
static Coroutine Meteor.Connection.Reconnect ( )
inlinestatic

Reconnect to the server. This is useful to call in an OnApplicationPause(bool pause) when pause is false (resuming)

Property Documentation

bool Meteor.Connection.Connected
staticget

Gets a value indicating whether you have successfully connected to the Meteor server.

true if connected; otherwise, false.

bool Meteor.Connection.Logging
staticgetset

Should logging of all messages be enabled for this connection?

true if logging; otherwise, false.

string Meteor.Connection.Url
staticgetset

The URL to connect to. Note, Meteor hosted sites do NOT support

wss (secured Webscokets) protocols, while Modulus hosted sites do.

Examples:

ws://localhost:3000/websocket
wss://yourmeteorapp.com/websocket
ws://yourexampleapp.meteor.com/websocket

The URL.

Event Documentation

Action Meteor.Connection.DidConnect
static

Raised when we succcessfully connect.


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