C# Class Goedel.Mesh.Connection

Describes network connection parameters for an application

Inheritance: MeshItem

Mostra file Open project: hallambaker/Mathematical-Mesh Class Usage Examples

Public Properties

Property	Type	Description
SecureAuth	bool

Public Methods

Method	Description
Connection ( ) : System	Default Constructor
Connection ( JSONReader JSONReader ) : System	Initialize class from JSONReader stream.
Connection ( string _String ) : System	Initialize class from a JSON encoded class.
Connection ( string Server, int Port, AppProtocol AppProtocol, string Account, string Password, TLSMode TLSMode, bool SecureAuth ) : System	Construct a connection object from parameters.
Connection ( string DNS, int Port, string Prefix, List Security ) : System	Convenience constructor, create instance from the principal fields.
DeserializeToken ( JSONReader JSONReader, string Tag ) : void	Having read a tag, process the corresponding value data.
Dump ( ) : void	Debug routine, writes data to the console.
From ( byte _Data ) : Connection	Create a new instance from untagged byte input. i.e. {... data ... }
From ( string _Input ) : Connection	Create a new instance from untagged string input. i.e. {... data ... }
FromTagged ( JSONReader JSONReader ) : Connection	Deserialize a tagged stream
FromTagged ( byte _Data ) : Connection	Create a new instance from tagged byte input. i.e. { "Connection" : {... data ... } }
FromTagged ( string _Input ) : Connection	Create a new instance from tagged string input. i.e. { "Connection" : {... data ... } }
Serialize ( Writer Writer, bool wrap, bool &first ) : void	Serialize this object to the specified output stream.
SerializeX ( Writer _Writer, bool _wrap, bool &_first ) : void	Serialize this object to the specified output stream. Unlike the Serlialize() method, this method is not inherited from the parent class allowing a specific version of the method to be called.
Tag ( ) : string	Tag identifying this class.

Method Details

Connection() public method

Default Constructor

public Connection ( ) : System
return	System

Connection() public method

Initialize class from JSONReader stream.

public Connection ( JSONReader JSONReader ) : System
JSONReader	JSONReader	Input stream
return	System

Connection() public method

Initialize class from a JSON encoded class.

public Connection ( string _String ) : System
_String	string	Input string
return	System

Connection() public method

Construct a connection object from parameters.

public Connection ( string Server, int Port, AppProtocol AppProtocol, string Account, string Password, TLSMode TLSMode, bool SecureAuth ) : System
Server	string	DNS service name
Port	int	IP Port number
AppProtocol	AppProtocol	Application protocol prefix.
Account	string	Account name for authenticaiton
Password	string	Password for authenticaiton
TLSMode	TLSMode	TLS Mode, may be Raw, Upgrade or None.
SecureAuth	bool	If true, a /// secure authentication mechanism must be used.
return	System

Connection() public method

Convenience constructor, create instance from the principal fields.

public Connection ( string DNS, int Port, string Prefix, List Security ) : System
DNS	string	DNS Name
Port	int	IP Port Number
Prefix	string	DNS service prefix
Security	List	Security enhancements
return	System

DeserializeToken() public method

Having read a tag, process the corresponding value data.

public DeserializeToken ( JSONReader JSONReader, string Tag ) : void
JSONReader	JSONReader	The input stream
Tag	string	The tag
return	void

Dump() public method

Debug routine, writes data to the console.

public Dump ( ) : void
return	void

From() public static method

Create a new instance from untagged byte input. i.e. {... data ... }

public static From ( byte _Data ) : Connection
_Data	byte	The input data.
return	Connection

From() public static method

Create a new instance from untagged string input. i.e. {... data ... }

public static From ( string _Input ) : Connection
_Input	string	The input data.
return	Connection

FromTagged() public static method

Deserialize a tagged stream

public static FromTagged ( JSONReader JSONReader ) : Connection
JSONReader	JSONReader	The input stream
return	Connection

FromTagged() public static method

Create a new instance from tagged byte input. i.e. { "Connection" : {... data ... } }

public static FromTagged ( byte _Data ) : Connection
_Data	byte	The input data.
return	Connection

FromTagged() public static method

Create a new instance from tagged string input. i.e. { "Connection" : {... data ... } }

public static FromTagged ( string _Input ) : Connection
_Input	string	The input data.
return	Connection

Serialize() public method

Serialize this object to the specified output stream.

public Serialize ( Writer Writer, bool wrap, bool &first ) : void
Writer	Writer	Output stream
wrap	bool	If true, output is wrapped with object /// start and end sequences '{ ... }'.
first	bool	If true, item is the first entry in a list.
return	void

SerializeX() public method

Serialize this object to the specified output stream. Unlike the Serlialize() method, this method is not inherited from the parent class allowing a specific version of the method to be called.

public SerializeX ( Writer _Writer, bool _wrap, bool &_first ) : void
_Writer	Writer	Output stream
_wrap	bool	If true, output is wrapped with object /// start and end sequences '{ ... }'.
_first	bool	If true, item is the first entry in a list.
return	void

Tag() public method

Tag identifying this class.

public Tag ( ) : string
return	string

Property Details

SecureAuth public_oe property

If true, force use of secure authentication.

public bool SecureAuth
return	bool