mirror of
https://github.com/PepperDash/PepperDashCore.git
synced 2026-02-11 10:44:49 +00:00
2138 lines
90 KiB
XML
2138 lines
90 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>PepperDash_Core</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="F:PepperDash.Core.WebApi.Presets.WebApiPasscodeClient.J2SMaster">
|
|
<summary>
|
|
An embedded JsonToSimpl master object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.WebApi.Presets.WebApiPasscodeClient.#ctor">
|
|
<summary>
|
|
SIMPL+ can only execute the default constructor. If you have variables that require initialization, please
|
|
use an Initialize method
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.WebApi.Presets.WebApiPasscodeClient.GetPresetForThisUser(System.Int32,System.Int32)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="roomTypeId"></param>
|
|
<param name="presetNumber"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.WebApi.Presets.WebApiPasscodeClient.SavePresetForThisUser(System.Int32,System.Int32)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="roomTypeId"></param>
|
|
<param name="presetNumber"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.WebApi.Presets.WebApiPasscodeClient.SaveCallback(System.String)">
|
|
<summary>
|
|
After save operation on JSON master happens, send it to server
|
|
</summary>
|
|
<param name="json"></param>
|
|
</member>
|
|
<member name="T:PepperDash.Core.Device">
|
|
<summary>
|
|
The core event and status-bearing class that most if not all device and connectors can derive from.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Device.#ctor(System.String)">
|
|
<summary>
|
|
Base constructor for all Devices.
|
|
</summary>
|
|
<param name="key"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Device.Activate">
|
|
<summary>
|
|
Gets this device ready to be used in the system. Runs any added pre-activation items, and
|
|
all post-activation at end. Classes needing additional logic to
|
|
run should override CustomActivate()
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Device.CustomActivate">
|
|
<summary>
|
|
Called in between Pre and PostActivationActions when Activate() is called.
|
|
Override to provide addtitional setup when calling activation. Overriding classes
|
|
do not need to call base.CustomActivate()
|
|
</summary>
|
|
<returns>true if device activated successfully.</returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Device.Deactivate">
|
|
<summary>
|
|
Call to deactivate device - unlink events, etc. Overriding classes do not
|
|
need to call base.Deactivate()
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Device.OnFalse(System.Object,System.Action)">
|
|
<summary>
|
|
Helper method to check object for bool value false and fire an Action method
|
|
</summary>
|
|
<param name="o">Should be of type bool, others will be ignored</param>
|
|
<param name="a">Action to be run when o is false</param>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpServer.ServerCCSection">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpServer.MonitorClient">
|
|
<summary>
|
|
A bandaid client that monitors whether the server is reachable
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpServer.MonitorClientTimer">
|
|
<summary>
|
|
Timer to operate the bandaid monitor client in a loop.
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpServer.MonitorClientFailureCount">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpServer.ProgramIsStopping">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.#ctor">
|
|
<summary>
|
|
constructor S+ Does not accept a key. Use initialze with key to set the debug key on this device. If using with + make sure to set all properties manually.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.#ctor(System.String)">
|
|
<summary>
|
|
constructor with debug key set at instantiation. Make sure to set all properties before listening.
|
|
</summary>
|
|
<param name="key"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.#ctor(PepperDash.Core.TcpServerConfigObject)">
|
|
<summary>
|
|
Contstructor that sets all properties by calling the initialize method with a config object.
|
|
</summary>
|
|
<param name="serverConfigObject"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.KillServer">
|
|
<summary>
|
|
Disconnects all clients and stops the server
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.Initialize(System.String)">
|
|
<summary>
|
|
Initialize Key for device using client name from SIMPL+. Called on Listen from SIMPL+
|
|
</summary>
|
|
<param name="key"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.Listen">
|
|
<summary>
|
|
Start listening on the specified port
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.StopListening">
|
|
<summary>
|
|
Stop Listeneing
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.DisconnectClient(System.UInt32)">
|
|
<summary>
|
|
Disconnects Client
|
|
</summary>
|
|
<param name="client"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.DisconnectAllClientsForShutdown">
|
|
<summary>
|
|
Disconnect All Clients
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.BroadcastText(System.String)">
|
|
<summary>
|
|
Broadcast text from server to all connected clients
|
|
</summary>
|
|
<param name="text"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.SendTextToClient(System.String,System.UInt32)">
|
|
<summary>
|
|
Not sure this is useful in library, maybe Pro??
|
|
</summary>
|
|
<param name="text"></param>
|
|
<param name="clientIndex"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.SecureServer_SocketStatusChange(Crestron.SimplSharp.CrestronSockets.SecureTCPServer,System.UInt32,Crestron.SimplSharp.CrestronSockets.SocketStatus)">
|
|
<summary>
|
|
Secure Server Socket Status Changed Callback
|
|
</summary>
|
|
<param name="mySecureTCPServer"></param>
|
|
<param name="clientIndex"></param>
|
|
<param name="serverSocketStatus"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.SecureConnectCallback(Crestron.SimplSharp.CrestronSockets.SecureTCPServer,System.UInt32)">
|
|
<summary>
|
|
Secure TCP Client Connected to Secure Server Callback
|
|
</summary>
|
|
<param name="mySecureTCPServer"></param>
|
|
<param name="clientIndex"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.SecureReceivedDataAsyncCallback(Crestron.SimplSharp.CrestronSockets.SecureTCPServer,System.UInt32,System.Int32)">
|
|
<summary>
|
|
Secure Received Data Async Callback
|
|
</summary>
|
|
<param name="mySecureTCPServer"></param>
|
|
<param name="clientIndex"></param>
|
|
<param name="numberOfBytesReceived"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.CrestronEnvironment_ProgramStatusEventHandler(Crestron.SimplSharp.eProgramStatusEventType)">
|
|
<summary>
|
|
Private Event Handler method to handle the closing of connections when the program stops
|
|
</summary>
|
|
<param name="programEventType"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.StartMonitorClient">
|
|
<summary>
|
|
Starts the monitor client cycle. Timed wait, then call RunMonitorClient
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.RunMonitorClient">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.StopMonitorClient">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.MonitorClient_IsReadyForComm(System.Object,PepperDash.Core.GenericTcpServerClientReadyForcommunicationsEventArgs)">
|
|
<summary>
|
|
On monitor connect, restart the operation
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpServer.MonitorClientHasHungCallback">
|
|
<summary>
|
|
If the client hangs, add to counter and maybe fire the choke event
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericSecureTcpIpServer.TextReceived">
|
|
<summary>
|
|
Event for Receiving text
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericSecureTcpIpServer.ClientConnectionChange">
|
|
<summary>
|
|
Event for client connection socket status change
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericSecureTcpIpServer.ServerStateChange">
|
|
<summary>
|
|
Event for Server State Change
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericSecureTcpIpServer.ServerClientReadyForCommunications">
|
|
<summary>
|
|
For a server with a pre shared key, this will fire after the communication is established and the key exchange is complete. If no shared key, this will fire
|
|
after connection is successful. Use this event to know when the client is ready for communication to avoid stepping on shared key.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.ServerHasChoked">
|
|
<summary>
|
|
A band aid event to notify user that the server has choked.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.MonitorClientMaxFailureCount">
|
|
<summary>
|
|
3 by default
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.Status">
|
|
<summary>
|
|
Text representation of the Socket Status enum values for the server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.IsConnected">
|
|
<summary>
|
|
Bool showing if socket is connected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.UIsConnected">
|
|
<summary>
|
|
S+ helper for IsConnected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.IsListening">
|
|
<summary>
|
|
Bool showing if socket is connected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.UIsListening">
|
|
<summary>
|
|
S+ helper for IsConnected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.NumberOfClientsConnected">
|
|
<summary>
|
|
Number of clients currently connected.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.Port">
|
|
<summary>
|
|
Port Server should listen on
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.UPort">
|
|
<summary>
|
|
S+ helper for Port
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.SharedKeyRequired">
|
|
<summary>
|
|
Bool to show whether the server requires a preshared key. Must be set the same in the client, and if true shared keys must be identical on server/client
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.USharedKeyRequired">
|
|
<summary>
|
|
S+ helper for requires shared key bool
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.SharedKey">
|
|
<summary>
|
|
SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module.
|
|
If SharedKey changes while server is listening or clients are connected, disconnect and stop listening will be called
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.HeartbeatRequired">
|
|
<summary>
|
|
Heartbeat Required bool sets whether server disconnects client if heartbeat is not received
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.UHeartbeatRequired">
|
|
<summary>
|
|
S+ Helper for Heartbeat Required
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.HeartbeatRequiredIntervalMs">
|
|
<summary>
|
|
Milliseconds before server expects another heartbeat. Set by property HeartbeatRequiredIntervalInSeconds which is driven from S+
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.HeartbeatRequiredIntervalInSeconds">
|
|
<summary>
|
|
Simpl+ Heartbeat Analog value in seconds
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.HeartbeatStringToMatch">
|
|
<summary>
|
|
String to Match for heartbeat. If null or empty any string will reset heartbeat timer
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.BufferSize">
|
|
<summary>
|
|
Defaults to 2000
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpServer.ServerStopped">
|
|
<summary>
|
|
Private flag to note that the server has stopped intentionally
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.UnsavedValues">
|
|
Privates *
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.#ctor">
|
|
<summary>
|
|
SIMPL+ default constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.Initialize(System.String)">
|
|
<summary>
|
|
Sets up class - overriding methods should always call this.
|
|
</summary>
|
|
<param name="uniqueId"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.AddChild(PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase)">
|
|
<summary>
|
|
Adds a child "module" to this master
|
|
</summary>
|
|
<param name="child"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.AddUnsavedValue(System.String,Newtonsoft.Json.Linq.JValue)">
|
|
<summary>
|
|
Called from the child to add changed or new values for saving
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.BoolChange">
|
|
Events *
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.Key">
|
|
<summary>
|
|
Mirrors the Unique ID for now.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.DebugName">
|
|
<summary>
|
|
Merely for use in debug messages
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.PathPrefix">
|
|
<summary>
|
|
This will be prepended to all paths to allow path swapping or for more organized
|
|
sub-paths
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.PathSuffix">
|
|
<summary>
|
|
This is added to the end of all paths
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.DebugOn">
|
|
<summary>
|
|
Enables debugging output to the console. Certain error messages will be logged to the
|
|
system's error log regardless of this setting
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplMaster.UDebug">
|
|
<summary>
|
|
Ushort helper for Debug property
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.JsonToSimpl.JsonToSimplFileMaster.StringBuilderLock">
|
|
Privates *
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplFileMaster.#ctor">
|
|
<summary>
|
|
SIMPL+ default constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplFileMaster.EvaluateFile(System.String)">
|
|
<summary>
|
|
Read, evaluate and udpate status
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplFileMaster.Filepath">
|
|
<summary>
|
|
Sets the filepath as well as registers this with the Global.Masters list
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.Initialize(System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Call this before doing anything else
|
|
</summary>
|
|
<param name="file"></param>
|
|
<param name="key"></param>
|
|
<param name="pathPrefix"></param>
|
|
<param name="pathSuffix"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.SetBoolPath(System.UInt16,System.String)">
|
|
<summary>
|
|
Set the JPath to evaluate for a given bool out index.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.SetUshortPath(System.UInt16,System.String)">
|
|
<summary>
|
|
Set the JPath for a ushort out index.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.SetStringPath(System.UInt16,System.String)">
|
|
<summary>
|
|
Set the JPath for a string output index.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.ProcessAll">
|
|
<summary>
|
|
Evalutates all outputs with defined paths. called by S+ when paths are ready to process
|
|
and by Master when file is read.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.ProcessBoolPath(System.UInt16)">
|
|
<summary>
|
|
Processes a bool property, converting to bool, firing off a BoolChange event
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.Process(System.String,System.String@)">
|
|
<summary>
|
|
Processes the given path.
|
|
</summary>
|
|
<param name="path">JPath formatted path to the desired property</param>
|
|
<param name="response">The string value of the property, or a default value if it
|
|
doesn't exist</param>
|
|
<returns> This will return false in the case that EvaulateAllOnJsonChange
|
|
is false and the path does not evaluate to a property in the incoming JSON. </returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.UpdateInputsForMaster">
|
|
<summary>
|
|
Called from Master to read inputs and update their values in master JObject
|
|
Callback should hit one of the following four methods
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.GetFullPath(System.String)">
|
|
<summary>
|
|
Called during Process(...) to get the path to a given property. By default,
|
|
returns PathPrefix+path+PathSuffix. Override to change the way path is built.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.SetAllPathsDelegate">
|
|
<summary>
|
|
Use a callback to reduce task switch/threading
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.PathPrefix">
|
|
<summary>
|
|
This will be prepended to all paths to allow path swapping or for more organized
|
|
sub-paths
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplChildObjectBase.PathSuffix">
|
|
<summary>
|
|
This is added to the end of all paths
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.ControlPropertiesConfig">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.ControlPropertiesConfig.EndOfLineString">
|
|
<summary>
|
|
Defaults to Environment.NewLine;
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpClient_ForServer.ConnectionHasHungCallback">
|
|
<summary>
|
|
This is something of a band-aid callback. If the client times out during the connection process, because the server
|
|
is stuck, this will fire. It is intended to be used by the Server class monitor client, to help
|
|
keep a watch on the server and reset it if necessary.
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpClient_ForServer.IsTryingToConnect">
|
|
<summary>
|
|
Semaphore on connect method
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpClient_ForServer.DisconnectCalledByUser">
|
|
<summary>
|
|
Flag Set only when the disconnect method is called.
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpClient_ForServer.RetryTimer">
|
|
<summary>
|
|
private Timer for auto reconnect
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpClient_ForServer.ConnectFailTimer">
|
|
<summary>
|
|
Used to force disconnection on a dead connect attempt
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericSecureTcpIpClient_ForServer.Client">
|
|
<summary>
|
|
Internal secure client
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.Initialize(System.String)">
|
|
<summary>
|
|
Just to help S+ set the key
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.CrestronEnvironment_ProgramStatusEventHandler(Crestron.SimplSharp.eProgramStatusEventType)">
|
|
<summary>
|
|
Handles closing this up when the program shuts down
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.Connect">
|
|
<summary>
|
|
Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.Disconnect">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.Cleanup">
|
|
<summary>
|
|
Internal call to close up client. ALWAYS use this when disconnecting.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.CheckClosedAndTryReconnect">
|
|
<summary>ff
|
|
Called from Connect failure or Socket Status change if
|
|
auto reconnect and socket disconnected (Not disconnected by user)
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.Receive(Crestron.SimplSharp.CrestronSockets.SecureTCPClient,System.Int32)">
|
|
<summary>
|
|
Receive callback
|
|
</summary>
|
|
<param name="client"></param>
|
|
<param name="numBytes"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.StopWaitForSharedKeyTimer">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.SendText(System.String)">
|
|
<summary>
|
|
General send method
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.SendBytes(System.Byte[])">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.Client_SocketStatusChange(Crestron.SimplSharp.CrestronSockets.SecureTCPClient,Crestron.SimplSharp.CrestronSockets.SocketStatus)">
|
|
<summary>
|
|
SocketStatusChange Callback
|
|
</summary>
|
|
<param name="client"></param>
|
|
<param name="clientSocketStatus"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.OnConnectionChange">
|
|
<summary>
|
|
Helper for ConnectionChange event
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSecureTcpIpClient_ForServer.OnClientReadyForcommunications(System.Boolean)">
|
|
<summary>
|
|
Helper to fire ClientReadyForCommunications event
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericSecureTcpIpClient_ForServer.ClientReadyForCommunications">
|
|
<summary>
|
|
For a client with a pre shared key, this will fire after the communication is established and the key exchange is complete. If you require
|
|
a key and subscribe to the socket change event and try to send data on a connection the data sent will interfere with the key exchange and disconnect.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.Hostname">
|
|
<summary>
|
|
Address of server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.Port">
|
|
<summary>
|
|
Port on server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.UPort">
|
|
<summary>
|
|
S+ helper
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.SharedKeyRequired">
|
|
<summary>
|
|
Bool to show whether the server requires a preshared key. This is used in the DynamicTCPServer class
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.USharedKeyRequired">
|
|
<summary>
|
|
S+ helper for requires shared key bool
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.SharedKey">
|
|
<summary>
|
|
SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.WaitingForSharedKeyResponse">
|
|
<summary>
|
|
flag to show the client is waiting for the server to send the shared key
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.BufferSize">
|
|
<summary>
|
|
Defaults to 2000
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.IsConnected">
|
|
<summary>
|
|
Bool showing if socket is connected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.UIsConnected">
|
|
<summary>
|
|
S+ helper for IsConnected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.IsReadyForCommunication">
|
|
<summary>
|
|
Bool showing if socket is ready for communication after shared key exchange
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.UIsReadyForCommunication">
|
|
<summary>
|
|
S+ helper for IsReadyForCommunication
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.ClientStatus">
|
|
<summary>
|
|
Client socket status Read only
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.UStatus">
|
|
<summary>
|
|
Contains the familiar Simpl analog status values. This drives the ConnectionChange event
|
|
and IsConnected would be true when this == 2.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.ClientStatusText">
|
|
<summary>
|
|
Status text shows the message associated with socket status
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.AutoReconnect">
|
|
<summary>
|
|
bool to track if auto reconnect should be set on the socket
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.UAutoReconnect">
|
|
<summary>
|
|
S+ helper for AutoReconnect
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSecureTcpIpClient_ForServer.AutoReconnectIntervalMs">
|
|
<summary>
|
|
Milliseconds to wait before attempting to reconnect. Defaults to 5000
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.GenericSecureTcpIpClient_ForServer.ConnectionHasHungCallbackDelegate">
|
|
<summary>
|
|
Band aid delegate for choked server
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.ICommunicationReceiver">
|
|
<summary>
|
|
An incoming communication stream
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.IBasicCommunication">
|
|
<summary>
|
|
Represents a device that uses basic connection
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.ISocketStatus">
|
|
<summary>
|
|
For IBasicCommunication classes that have SocketStatus. GenericSshClient,
|
|
GenericTcpIpClient
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.eGenericCommMethodStatusChangeType">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.GenericCommMethodStatusHandler">
|
|
<summary>
|
|
This delegate defines handler for IBasicCommunication status changes
|
|
</summary>
|
|
<param name="comm">Device firing the status change</param>
|
|
<param name="status"></param>
|
|
</member>
|
|
<member name="T:PepperDash.Core.GenericCommMethodReceiveBytesArgs">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericCommMethodReceiveBytesArgs.#ctor">
|
|
<summary>
|
|
Stupid S+ Constructor
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.GenericCommMethodReceiveTextArgs">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericCommMethodReceiveTextArgs.#ctor">
|
|
<summary>
|
|
Stupid S+ Constructor
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.ComTextHelper">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:PepperDash.Core.DebugThings.DebugContextCollection.SetLevel(System.String,System.Int32)" -->
|
|
<member name="M:PepperDash.Core.DebugThings.DebugContextCollection.GetOrCreateItem(System.String)">
|
|
<summary>
|
|
Gets a level or creates it if not existing
|
|
</summary>
|
|
<param name="contextKey"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.J2SGlobal.AddMaster(PepperDash.Core.JsonToSimpl.JsonToSimplMaster)">
|
|
<summary>
|
|
Adds a file master. If the master's key or filename is equivalent to any existing
|
|
master, this will fail
|
|
</summary>
|
|
<param name="master">New master to add</param>
|
|
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.J2SGlobal.GetMasterByFile(System.String)">
|
|
<summary>
|
|
Gets a master by its key. Case-insensitive
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.JsonToSimpl.JsonToSimplGenericMaster.StringBuilderLock">
|
|
Privates *
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplGenericMaster.#ctor">
|
|
<summary>
|
|
SIMPL+ default constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplGenericMaster.LoadWithJson(System.String)">
|
|
<summary>
|
|
Loads in JSON and triggers evaluation on all children
|
|
</summary>
|
|
<param name="json"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplGenericMaster.SetJsonWithoutEvaluating(System.String)">
|
|
<summary>
|
|
Loads JSON into JsonObject, but does not trigger evaluation by children
|
|
</summary>
|
|
<param name="json"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplGenericMaster.Save">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpClient_ForServer.ConnectionHasHungCallback">
|
|
<summary>
|
|
This is something of a band-aid callback. If the client times out during the connection process, because the server
|
|
is stuck, this will fire. It is intended to be used by the Server class monitor client, to help
|
|
keep a watch on the server and reset it if necessary.
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpClient_ForServer.IsTryingToConnect">
|
|
<summary>
|
|
Semaphore on connect method
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpClient_ForServer.DisconnectCalledByUser">
|
|
<summary>
|
|
Flag Set only when the disconnect method is called.
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpClient_ForServer.RetryTimer">
|
|
<summary>
|
|
private Timer for auto reconnect
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpClient_ForServer.ConnectFailTimer">
|
|
<summary>
|
|
Used to force disconnection on a dead connect attempt
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpClient_ForServer.Client">
|
|
<summary>
|
|
Internal secure client
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.Initialize(System.String)">
|
|
<summary>
|
|
Just to help S+ set the key
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.CrestronEnvironment_ProgramStatusEventHandler(Crestron.SimplSharp.eProgramStatusEventType)">
|
|
<summary>
|
|
Handles closing this up when the program shuts down
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.Connect">
|
|
<summary>
|
|
Connect Method. Will return if already connected. Will write errors if missing address, port, or unique key/name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.Disconnect">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.Cleanup">
|
|
<summary>
|
|
Internal call to close up client. ALWAYS use this when disconnecting.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.CheckClosedAndTryReconnect">
|
|
<summary>ff
|
|
Called from Connect failure or Socket Status change if
|
|
auto reconnect and socket disconnected (Not disconnected by user)
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.Receive(Crestron.SimplSharp.CrestronSockets.TCPClient,System.Int32)">
|
|
<summary>
|
|
Receive callback
|
|
</summary>
|
|
<param name="client"></param>
|
|
<param name="numBytes"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.StopWaitForSharedKeyTimer">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.SendText(System.String)">
|
|
<summary>
|
|
General send method
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.SendBytes(System.Byte[])">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.Client_SocketStatusChange(Crestron.SimplSharp.CrestronSockets.TCPClient,Crestron.SimplSharp.CrestronSockets.SocketStatus)">
|
|
<summary>
|
|
SocketStatusChange Callback
|
|
</summary>
|
|
<param name="client"></param>
|
|
<param name="clientSocketStatus"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.OnConnectionChange">
|
|
<summary>
|
|
Helper for ConnectionChange event
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient_ForServer.OnClientReadyForcommunications(System.Boolean)">
|
|
<summary>
|
|
Helper to fire ClientReadyForCommunications event
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericTcpIpClient_ForServer.ClientReadyForCommunications">
|
|
<summary>
|
|
For a client with a pre shared key, this will fire after the communication is established and the key exchange is complete. If you require
|
|
a key and subscribe to the socket change event and try to send data on a connection the data sent will interfere with the key exchange and disconnect.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.Hostname">
|
|
<summary>
|
|
Address of server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.Port">
|
|
<summary>
|
|
Port on server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.UPort">
|
|
<summary>
|
|
S+ helper
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.SharedKeyRequired">
|
|
<summary>
|
|
Bool to show whether the server requires a preshared key. This is used in the DynamicTCPServer class
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.USharedKeyRequired">
|
|
<summary>
|
|
S+ helper for requires shared key bool
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.SharedKey">
|
|
<summary>
|
|
SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.WaitingForSharedKeyResponse">
|
|
<summary>
|
|
flag to show the client is waiting for the server to send the shared key
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.BufferSize">
|
|
<summary>
|
|
Defaults to 2000
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.IsConnected">
|
|
<summary>
|
|
Bool showing if socket is connected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.UIsConnected">
|
|
<summary>
|
|
S+ helper for IsConnected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.IsReadyForCommunication">
|
|
<summary>
|
|
Bool showing if socket is ready for communication after shared key exchange
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.UIsReadyForCommunication">
|
|
<summary>
|
|
S+ helper for IsReadyForCommunication
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.ClientStatus">
|
|
<summary>
|
|
Client socket status Read only
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.UStatus">
|
|
<summary>
|
|
Contains the familiar Simpl analog status values. This drives the ConnectionChange event
|
|
and IsConnected would be true when this == 2.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.ClientStatusText">
|
|
<summary>
|
|
Status text shows the message associated with socket status
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.AutoReconnect">
|
|
<summary>
|
|
bool to track if auto reconnect should be set on the socket
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.UAutoReconnect">
|
|
<summary>
|
|
S+ helper for AutoReconnect
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient_ForServer.AutoReconnectIntervalMs">
|
|
<summary>
|
|
Milliseconds to wait before attempting to reconnect. Defaults to 5000
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.GenericTcpIpClient_ForServer.ConnectionHasHungCallbackDelegate">
|
|
<summary>
|
|
Band aid delegate for choked server
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.WebApi.Presets.User">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.WebApi.Presets.UserReceivedEventArgs">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.WebApi.Presets.UserReceivedEventArgs.#ctor">
|
|
<summary>
|
|
For Simpl+
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.WebApi.Presets.UserReceivedEventArgs.LookupSuccess">
|
|
<summary>
|
|
True when user is found
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.WebApi.Presets.UserReceivedEventArgs.ULookupSuccess">
|
|
<summary>
|
|
For stupid S+
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.WebApi.Presets.UserAndRoomMessage">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "M:PepperDash.Core.JsonToSimpl.JsonToSimplArrayLookupChild.Initialize(System.String,System.String,System.String,System.String,System.String,System.String)" -->
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplArrayLookupChild.InitializeWithAppend(System.String,System.String,System.String,System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
For newer >=2.4.1 array lookups.
|
|
</summary>
|
|
<param name="file"></param>
|
|
<param name="key"></param>
|
|
<param name="pathPrefix"></param>
|
|
<param name="pathAppend"></param>
|
|
<param name="pathSuffix"></param>
|
|
<param name="searchPropertyName"></param>
|
|
<param name="searchPropertyValue"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplArrayLookupChild.GetFullPath(System.String)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="path"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplArrayLookupChild.GetPathAppend(System.String)">
|
|
<summary>
|
|
Provides the path append for GetFullPath
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplArrayLookupChild.FindInArray">
|
|
<summary>
|
|
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="P:PepperDash.Core.EthernetHelper.LanHelper">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.EthernetHelper.PortNumber">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.EthernetHelper.LinkActive">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.EthernetHelper.DhcpActive">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.EthernetHelper.Hostname">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.EthernetHelper.IPAddress">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.EthernetHelper.SubnetMask">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.EthernetHelper.DefaultGateway">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericHttpSseClient.GetResponseStreamCallback(Crestron.SimplSharp.Net.Http.HttpClientRequest,Crestron.SimplSharp.Net.Http.HTTP_CALLBACK_ERROR,System.Object)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="asynchronousResult"></param>
|
|
<param name="error"></param>
|
|
<param name="status"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericHttpSseClient.ReadCallBack(Crestron.SimplSharp.CrestronIO.IAsyncResult)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="asyncResult"></param>
|
|
</member>
|
|
<member name="T:PepperDash.Core.RequestState">
|
|
<summary>
|
|
Stores the state of the request
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.StreamAsyncTest">
|
|
<summary>
|
|
Waithandle for main thread.
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.WebApi.Presets.PresetReceivedEventArgs">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.WebApi.Presets.PresetReceivedEventArgs.#ctor">
|
|
<summary>
|
|
For Simpl+
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.WebApi.Presets.PresetReceivedEventArgs.LookupSuccess">
|
|
<summary>
|
|
True when the preset is found
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.WebApi.Presets.PresetReceivedEventArgs.ULookupSuccess">
|
|
<summary>
|
|
S+ helper for stupid S+
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpClient.DisconnectCalledByUser">
|
|
<summary>
|
|
Set only when the disconnect method is called.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient.Initialize(System.String)">
|
|
<summary>
|
|
Just to help S+ set the key
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient.CrestronEnvironment_ProgramStatusEventHandler(Crestron.SimplSharp.eProgramStatusEventType)">
|
|
<summary>
|
|
Handles closing this up when the program shuts down
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient.SendText(System.String)">
|
|
<summary>
|
|
General send method
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpClient.SendEscapedText(System.String)">
|
|
<summary>
|
|
This is useful from console and...?
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericTcpIpClient.BytesReceived">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericTcpIpClient.TextReceived">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericTcpIpClient.ConnectionChange">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.Hostname">
|
|
<summary>
|
|
Address of server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.Port">
|
|
<summary>
|
|
Port on server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.UPort">
|
|
<summary>
|
|
Another damn S+ helper because S+ seems to treat large port nums as signed ints
|
|
which screws up things
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.BufferSize">
|
|
<summary>
|
|
Defaults to 2000
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.Client">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.IsConnected">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.UIsConnected">
|
|
<summary>
|
|
S+ helper for IsConnected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.ClientStatus">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.UStatus">
|
|
<summary>
|
|
Contains the familiar Simpl analog status values. This drives the ConnectionChange event
|
|
and IsConnected with be true when this == 2.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.ClientStatusText">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.ConnectionFailure">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.AutoReconnect">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.UAutoReconnect">
|
|
<summary>
|
|
S+ helper for AutoReconnect
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.AutoReconnectIntervalMs">
|
|
<summary>
|
|
Milliseconds to wait before attempting to reconnect. Defaults to 5000
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpClient.Connected">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.TcpSshPropertiesConfig.BufferSize">
|
|
<summary>
|
|
Defaults to 32768
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.TcpSshPropertiesConfig.AutoReconnect">
|
|
<summary>
|
|
Defaults to true
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.TcpSshPropertiesConfig.AutoReconnectIntervalMs">
|
|
<summary>
|
|
Defaults to 5000ms
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.GetDebugContext(System.String)">
|
|
<summary>
|
|
Creates or gets a debug context
|
|
</summary>
|
|
<param name="key"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.#ctor">
|
|
<summary>
|
|
Do not use. For S+ access.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.CrestronEnvironment_ProgramStatusEventHandler(Crestron.SimplSharp.eProgramStatusEventType)">
|
|
<summary>
|
|
Used to save memory when shutting down
|
|
</summary>
|
|
<param name="programEventType"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.SetDebugFromConsole(System.String)">
|
|
<summary>
|
|
Callback for console command
|
|
</summary>
|
|
<param name="levelString"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.SetDebugLevel(System.Int32)">
|
|
<summary>
|
|
Sets the debug level
|
|
</summary>
|
|
<param name="level"> Valid values 0 (no debug), 1 (critical), 2 (all messages)</param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.Console(System.UInt32,System.String,System.Object[])">
|
|
<summary>
|
|
Prints message to console if current debug level is equal to or higher than the level of this message.
|
|
Uses CrestronConsole.PrintLine.
|
|
</summary>
|
|
<param name="level"></param>
|
|
<param name="format">Console format string</param>
|
|
<param name="items">Object parameters</param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.Console(System.UInt32,PepperDash.Core.IKeyed,System.String,System.Object[])">
|
|
<summary>
|
|
Appends a device Key to the beginning of a message
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.SaveMemoryOnTimeout">
|
|
<summary>
|
|
Writes the memory object after timeout
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.SaveMemory">
|
|
<summary>
|
|
Writes the memory - use SaveMemoryOnTimeout
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.LoadMemory">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.DebugContext.GetMemoryFileName">
|
|
<summary>
|
|
Helper to get the file path for this app's debug memory
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.DebugContext.Key">
|
|
<summary>
|
|
Describes the folder location where a given program stores it's debug level memory. By default, the
|
|
file written will be named appNdebug where N is 1-10.
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.LineReceivedHandler">
|
|
<summary>
|
|
Defines the string event handler for line events on the gather
|
|
</summary>
|
|
<param name="text"></param>
|
|
</member>
|
|
<member name="T:PepperDash.Core.CommunicationGather">
|
|
<summary>
|
|
Attaches to IBasicCommunication as a text gather
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.CommunicationGather.ReceiveBuffer">
|
|
<summary>
|
|
For receive buffer
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.CommunicationGather.Delimiter">
|
|
<summary>
|
|
Delimiter, like it says!
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommunicationGather.#ctor(PepperDash.Core.ICommunicationReceiver,System.Char)">
|
|
<summary>
|
|
Fires up a gather, given a IBasicCommunicaion port and char for de
|
|
</summary>
|
|
<param name="port"></param>
|
|
<param name="delimiter"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommunicationGather.#ctor(PepperDash.Core.ICommunicationReceiver,System.String)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="port"></param>
|
|
<param name="delimiter"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommunicationGather.Stop">
|
|
<summary>
|
|
Disconnects this gather from the Port's TextReceived event. This will not fire LineReceived
|
|
after the this call.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommunicationGather.Port_TextReceived(System.Object,PepperDash.Core.GenericCommMethodReceiveTextArgs)">
|
|
<summary>
|
|
Handler for raw data coming from port
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommunicationGather.Port_TextReceivedStringDelimiter(System.Object,PepperDash.Core.GenericCommMethodReceiveTextArgs)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="sender"></param>
|
|
<param name="args"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommunicationGather.Finalize">
|
|
<summary>
|
|
Deconstructor. Disconnects from port TextReceived events.
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.CommunicationGather.LineReceived">
|
|
<summary>
|
|
Event that fires when a line is received from the IBasicCommunication source.
|
|
The event merely contains the text, not an EventArgs type class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.CommunicationGather.Port">
|
|
<summary>
|
|
The communication port that this gathers on
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.CommunicationGather.IncludeDelimiter">
|
|
<summary>
|
|
Default false. If true, the delimiter will be included in the line output
|
|
events
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.JsonToSimpl.JsonToSimplPortalFileMaster.StringBuilderLock">
|
|
Privates *
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplPortalFileMaster.#ctor">
|
|
<summary>
|
|
SIMPL+ default constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplPortalFileMaster.EvaluateFile(System.String)">
|
|
<summary>
|
|
Read, evaluate and udpate status
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplPortalFileMaster.GetActualFileInfoFromPath(System.String)">
|
|
<summary>
|
|
Returns the FileInfo object for a given path, with possible wildcards
|
|
</summary>
|
|
<param name="path"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplPortalFileMaster.setDebugLevel(System.Int32)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="level"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.JsonToSimpl.JsonToSimplPortalFileMaster.Save">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.JsonToSimpl.JsonToSimplPortalFileMaster.PortalFilepath">
|
|
<summary>
|
|
Sets the filepath as well as registers this with the Global.Masters list
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpServer.ServerCCSection">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpServer.MonitorClient">
|
|
<summary>
|
|
A bandaid client that monitors whether the server is reachable
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpServer.MonitorClientTimer">
|
|
<summary>
|
|
Timer to operate the bandaid monitor client in a loop.
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpServer.MonitorClientFailureCount">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericTcpIpServer.ProgramIsStopping">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.#ctor">
|
|
<summary>
|
|
constructor S+ Does not accept a key. Use initialze with key to set the debug key on this device. If using with + make sure to set all properties manually.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.#ctor(System.String)">
|
|
<summary>
|
|
constructor with debug key set at instantiation. Make sure to set all properties before listening.
|
|
</summary>
|
|
<param name="key"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.#ctor(PepperDash.Core.TcpServerConfigObject)">
|
|
<summary>
|
|
Contstructor that sets all properties by calling the initialize method with a config object.
|
|
</summary>
|
|
<param name="serverConfigObject"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.KillServer">
|
|
<summary>
|
|
Disconnects all clients and stops the server
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.Initialize(System.String)">
|
|
<summary>
|
|
Initialize Key for device using client name from SIMPL+. Called on Listen from SIMPL+
|
|
</summary>
|
|
<param name="key"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.Listen">
|
|
<summary>
|
|
Start listening on the specified port
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.StopListening">
|
|
<summary>
|
|
Stop Listeneing
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.DisconnectClient(System.UInt32)">
|
|
<summary>
|
|
Disconnects Client
|
|
</summary>
|
|
<param name="client"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.DisconnectAllClientsForShutdown">
|
|
<summary>
|
|
Disconnect All Clients
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.BroadcastText(System.String)">
|
|
<summary>
|
|
Broadcast text from server to all connected clients
|
|
</summary>
|
|
<param name="text"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.SendTextToClient(System.String,System.UInt32)">
|
|
<summary>
|
|
Not sure this is useful in library, maybe Pro??
|
|
</summary>
|
|
<param name="text"></param>
|
|
<param name="clientIndex"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.TcpServer_SocketStatusChange(Crestron.SimplSharp.CrestronSockets.TCPServer,System.UInt32,Crestron.SimplSharp.CrestronSockets.SocketStatus)">
|
|
<summary>
|
|
Secure Server Socket Status Changed Callback
|
|
</summary>
|
|
<param name="mySecureTCPServer"></param>
|
|
<param name="clientIndex"></param>
|
|
<param name="serverSocketStatus"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.TcpConnectCallback(Crestron.SimplSharp.CrestronSockets.TCPServer,System.UInt32)">
|
|
<summary>
|
|
Secure TCP Client Connected to Secure Server Callback
|
|
</summary>
|
|
<param name="mySecureTCPServer"></param>
|
|
<param name="clientIndex"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.TcpServerReceivedDataAsyncCallback(Crestron.SimplSharp.CrestronSockets.TCPServer,System.UInt32,System.Int32)">
|
|
<summary>
|
|
Secure Received Data Async Callback
|
|
</summary>
|
|
<param name="mySecureTCPServer"></param>
|
|
<param name="clientIndex"></param>
|
|
<param name="numberOfBytesReceived"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.CrestronEnvironment_ProgramStatusEventHandler(Crestron.SimplSharp.eProgramStatusEventType)">
|
|
<summary>
|
|
Private Event Handler method to handle the closing of connections when the program stops
|
|
</summary>
|
|
<param name="programEventType"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.StartMonitorClient">
|
|
<summary>
|
|
Starts the monitor client cycle. Timed wait, then call RunMonitorClient
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.RunMonitorClient">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.StopMonitorClient">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.MonitorClient_IsReadyForComm(System.Object,PepperDash.Core.GenericTcpServerClientReadyForcommunicationsEventArgs)">
|
|
<summary>
|
|
On monitor connect, restart the operation
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericTcpIpServer.MonitorClientHasHungCallback">
|
|
<summary>
|
|
If the client hangs, add to counter and maybe fire the choke event
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericTcpIpServer.TextReceived">
|
|
<summary>
|
|
Event for Receiving text
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericTcpIpServer.ClientConnectionChange">
|
|
<summary>
|
|
Event for client connection socket status change
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericTcpIpServer.ServerStateChange">
|
|
<summary>
|
|
Event for Server State Change
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericTcpIpServer.ServerClientReadyForCommunications">
|
|
<summary>
|
|
For a server with a pre shared key, this will fire after the communication is established and the key exchange is complete. If no shared key, this will fire
|
|
after connection is successful. Use this event to know when the client is ready for communication to avoid stepping on shared key.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.ServerHasChoked">
|
|
<summary>
|
|
A band aid event to notify user that the server has choked.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.MonitorClientMaxFailureCount">
|
|
<summary>
|
|
3 by default
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.Status">
|
|
<summary>
|
|
Text representation of the Socket Status enum values for the server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.IsConnected">
|
|
<summary>
|
|
Bool showing if socket is connected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.UIsConnected">
|
|
<summary>
|
|
S+ helper for IsConnected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.IsListening">
|
|
<summary>
|
|
Bool showing if socket is connected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.UIsListening">
|
|
<summary>
|
|
S+ helper for IsConnected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.NumberOfClientsConnected">
|
|
<summary>
|
|
Number of clients currently connected.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.Port">
|
|
<summary>
|
|
Port Server should listen on
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.UPort">
|
|
<summary>
|
|
S+ helper for Port
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.SharedKeyRequired">
|
|
<summary>
|
|
Bool to show whether the server requires a preshared key. Must be set the same in the client, and if true shared keys must be identical on server/client
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.USharedKeyRequired">
|
|
<summary>
|
|
S+ helper for requires shared key bool
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.SharedKey">
|
|
<summary>
|
|
SharedKey is sent for varification to the server. Shared key can be any text (255 char limit in SIMPL+ Module), but must match the Shared Key on the Server module.
|
|
If SharedKey changes while server is listening or clients are connected, disconnect and stop listening will be called
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.HeartbeatRequired">
|
|
<summary>
|
|
Heartbeat Required bool sets whether server disconnects client if heartbeat is not received
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.UHeartbeatRequired">
|
|
<summary>
|
|
S+ Helper for Heartbeat Required
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.HeartbeatRequiredIntervalMs">
|
|
<summary>
|
|
Milliseconds before server expects another heartbeat. Set by property HeartbeatRequiredIntervalInSeconds which is driven from S+
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.HeartbeatRequiredIntervalInSeconds">
|
|
<summary>
|
|
Simpl+ Heartbeat Analog value in seconds
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.HeartbeatStringToMatch">
|
|
<summary>
|
|
String to Match for heartbeat. If null or empty any string will reset heartbeat timer
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.BufferSize">
|
|
<summary>
|
|
Defaults to 2000
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericTcpIpServer.ServerStopped">
|
|
<summary>
|
|
Private flag to note that the server has stopped intentionally
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.Debug.FilePathPrefix">
|
|
<summary>
|
|
Describes the folder location where a given program stores it's debug level memory. By default, the
|
|
file written will be named appNdebug where N is 1-10.
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.Debug.FileName">
|
|
<summary>
|
|
The name of the file containing the current debug settings.
|
|
</summary>
|
|
</member>
|
|
<member name="F:PepperDash.Core.Debug.ExcludeAllMode">
|
|
<summary>
|
|
When true, the IncludedExcludedKeys dict will contain keys to include.
|
|
When false (default), IncludedExcludedKeys will contain keys to exclude.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.CrestronEnvironment_ProgramStatusEventHandler(Crestron.SimplSharp.eProgramStatusEventType)">
|
|
<summary>
|
|
Used to save memory when shutting down
|
|
</summary>
|
|
<param name="programEventType"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.SetDebugFromConsole(System.String)">
|
|
<summary>
|
|
Callback for console command
|
|
</summary>
|
|
<param name="levelString"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.SetDebugLevel(System.Int32)">
|
|
<summary>
|
|
Sets the debug level
|
|
</summary>
|
|
<param name="level"> Valid values 0 (no debug), 1 (critical), 2 (all messages)</param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.ShowDebugLog(System.String)">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.Console(System.UInt32,System.String,System.Object[])">
|
|
<summary>
|
|
Prints message to console if current debug level is equal to or higher than the level of this message.
|
|
Uses CrestronConsole.PrintLine.
|
|
</summary>
|
|
<param name="level"></param>
|
|
<param name="format">Console format string</param>
|
|
<param name="items">Object parameters</param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.Console(System.UInt32,PepperDash.Core.IKeyed,System.String,System.Object[])">
|
|
<summary>
|
|
Logs to Console when at-level, and all messages to error log, including device key
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.Console(System.UInt32,PepperDash.Core.Debug.ErrorLogLevel,System.String,System.Object[])">
|
|
<summary>
|
|
Logs to Console when at-level, and all messages to error log
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.ConsoleWithLog(System.UInt32,System.String,System.Object[])">
|
|
<summary>
|
|
Logs to both console and the custom user log (not the built-in error log). If appdebug level is set at
|
|
or above the level provided, then the output will be written to both console and the log. Otherwise
|
|
it will only be written to the log.
|
|
</summary>
|
|
<param name="level"></param>
|
|
<param name="format"></param>
|
|
<param name="items"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.ConsoleWithLog(System.UInt32,PepperDash.Core.IKeyed,System.String,System.Object[])">
|
|
<summary>
|
|
Logs to both console and the custom user log (not the built-in error log). If appdebug level is set at
|
|
or above the level provided, then the output will be written to both console and the log. Otherwise
|
|
it will only be written to the log.
|
|
</summary>
|
|
<param name="level"></param>
|
|
<param name="dev"></param>
|
|
<param name="format">String.format string</param>
|
|
<param name="items">Parameters for substitution in the format string.</param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.LogError(PepperDash.Core.Debug.ErrorLogLevel,System.String)">
|
|
<summary>
|
|
Prints to log and error log
|
|
</summary>
|
|
<param name="errorLogLevel"></param>
|
|
<param name="str"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.SaveMemoryOnTimeout">
|
|
<summary>
|
|
Writes the memory object after timeout
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.SaveMemory">
|
|
<summary>
|
|
Writes the memory - use SaveMemoryOnTimeout
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.LoadMemory">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Debug.GetMemoryFileName">
|
|
<summary>
|
|
Helper to get the file path for this app's debug memory
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Config.PortalConfigReader.ReadAndMergeFileIfNecessary(System.String,System.String)">
|
|
<summary>
|
|
Reads the config file, checks if it needs a merge, merges and saves, then returns the merged Object.
|
|
</summary>
|
|
<returns>JObject of config file</returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Config.PortalConfigReader.MergeConfigs(Newtonsoft.Json.Linq.JObject)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="doubleConfig"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Config.PortalConfigReader.MergeArraysOnTopLevelProperty(Newtonsoft.Json.Linq.JArray,Newtonsoft.Json.Linq.JArray,System.String,System.String)">
|
|
<summary>
|
|
Merges the contents of a base and a delta array, matching the entries on a top-level property
|
|
given by propertyName. Returns a merge of them. Items in the delta array that do not have
|
|
a matched item in base array will not be merged. Non keyed system items will replace the template items.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Config.PortalConfigReader.Merge(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken,System.String)">
|
|
<summary>
|
|
Helper for using with JTokens. Converts to JObject
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.Config.PortalConfigReader.Merge(Newtonsoft.Json.Linq.JObject,Newtonsoft.Json.Linq.JObject,System.String)">
|
|
<summary>
|
|
Merge o2 onto o1
|
|
</summary>
|
|
<param name="a"></param>
|
|
<param name="b"></param>
|
|
</member>
|
|
<member name="F:PepperDash.Core.GenericUdpServer.MessageQueue">
|
|
<summary>
|
|
Queue to temporarily store received messages with the source IP and Port info
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericUdpServer.Connect">
|
|
<summary>
|
|
Enables the UDP Server
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericUdpServer.Disconnect">
|
|
<summary>
|
|
Disabled the UDP Server
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericUdpServer.Receive(Crestron.SimplSharp.CrestronSockets.UDPServer,System.Int32)">
|
|
<summary>
|
|
Recursive method to receive data
|
|
</summary>
|
|
<param name="server"></param>
|
|
<param name="numBytes"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericUdpServer.DequeueEvent">
|
|
<summary>
|
|
This method gets spooled up in its own thread an protected by a CCriticalSection to prevent multiple threads from running concurrently.
|
|
It will dequeue items as they are enqueued automatically.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericUdpServer.SendText(System.String)">
|
|
<summary>
|
|
General send method
|
|
</summary>
|
|
<param name="text"></param>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericUdpServer.BytesReceived">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericUdpServer.TextReceived">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericUdpServer.DataRecievedExtra">
|
|
<summary>
|
|
This event will fire when a message is dequeued that includes the source IP and Port info if needed to determine the source of the received data.
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericUdpServer.ConnectionChange">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericUdpServer.Hostname">
|
|
<summary>
|
|
Address of server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericUdpServer.Port">
|
|
<summary>
|
|
Port on server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericUdpServer.UPort">
|
|
<summary>
|
|
Another damn S+ helper because S+ seems to treat large port nums as signed ints
|
|
which screws up things
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericUdpServer.IsConnected">
|
|
<summary>
|
|
Indicates that the UDP Server is enabled
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericUdpServer.BufferSize">
|
|
<summary>
|
|
Defaults to 2000
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericUdpReceiveTextExtraArgs.#ctor">
|
|
<summary>
|
|
Stupid S+ Constructor
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.UdpServerPropertiesConfig.BufferSize">
|
|
<summary>
|
|
Defaults to 32768
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.GenericSshClient">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.#ctor(System.String,System.String,System.Int32,System.String,System.String)">
|
|
<summary>
|
|
Typical constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.#ctor">
|
|
<summary>
|
|
S+ Constructor - Must set all properties before calling Connect
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.Initialize(System.String)">
|
|
<summary>
|
|
Just to help S+ set the key
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.CrestronEnvironment_ProgramStatusEventHandler(Crestron.SimplSharp.eProgramStatusEventType)">
|
|
<summary>
|
|
Handles closing this up when the program shuts down
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.Connect">
|
|
<summary>
|
|
Connect to the server, using the provided properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.Disconnect">
|
|
<summary>
|
|
Disconnect the clients and put away it's resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.HandleConnectionFailure">
|
|
<summary>
|
|
Anything to do with reestablishing connection on failures
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.kauth_AuthenticationPrompt(System.Object,Crestron.SimplSharp.Ssh.Common.AuthenticationPromptEventArgs)">
|
|
<summary>
|
|
Handles the keyboard interactive authentication, should it be required.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.Stream_DataReceived(System.Object,Crestron.SimplSharp.Ssh.Common.ShellDataEventArgs)">
|
|
<summary>
|
|
Handler for data receive on ShellStream. Passes data across to queue for line parsing.
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.Client_ErrorOccurred(System.Object,Crestron.SimplSharp.Ssh.Common.ExceptionEventArgs)">
|
|
<summary>
|
|
Error event handler for client events - disconnect, etc. Will forward those events via ConnectionChange
|
|
event
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.OnConnectionChange">
|
|
<summary>
|
|
Helper for ConnectionChange event
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.GenericSshClient.SendText(System.String)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="text"></param>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericSshClient.BytesReceived">
|
|
<summary>
|
|
Event that fires when data is received. Delivers args with byte array
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericSshClient.TextReceived">
|
|
<summary>
|
|
Event that fires when data is received. Delivered as text.
|
|
</summary>
|
|
</member>
|
|
<member name="E:PepperDash.Core.GenericSshClient.ConnectionChange">
|
|
<summary>
|
|
Event when the connection status changes.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.Hostname">
|
|
<summary>
|
|
Address of server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.Port">
|
|
<summary>
|
|
Port on server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.Username">
|
|
<summary>
|
|
Username for server
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.Password">
|
|
<summary>
|
|
And... Password for server. That was worth documenting!
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.IsConnected">
|
|
<summary>
|
|
True when the server is connected - when status == 2.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.UIsConnected">
|
|
<summary>
|
|
S+ helper for IsConnected
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.ClientStatus">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.UStatus">
|
|
<summary>
|
|
Contains the familiar Simpl analog status values. This drives the ConnectionChange event
|
|
and IsConnected with be true when this == 2.
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.AutoReconnect">
|
|
<summary>
|
|
Determines whether client will attempt reconnection on failure. Default is true
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.ConnectEnabled">
|
|
<summary>
|
|
Will be set and unset by connect and disconnect only
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.UAutoReconnect">
|
|
<summary>
|
|
S+ helper for AutoReconnect
|
|
</summary>
|
|
</member>
|
|
<member name="P:PepperDash.Core.GenericSshClient.AutoReconnectIntervalMs">
|
|
<summary>
|
|
Millisecond value, determines the timeout period in between reconnect attempts.
|
|
Set to 5000 by default
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.SshConnectionChangeEventArgs">
|
|
<summary>
|
|
Fired when connection changes
|
|
</summary>
|
|
</member>
|
|
<member name="T:PepperDash.Core.CommStatic">
|
|
<summary>
|
|
Background class that manages debug features for sockets
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommStatic.#cctor">
|
|
<summary>
|
|
Sets up the backing class. Adds console commands for S#Pro programs
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommStatic.GetSocketType(PepperDash.Core.ISocketStatus)">
|
|
<summary>
|
|
Helper for socket list, to show types
|
|
</summary>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommStatic.AddSocket(PepperDash.Core.ISocketStatus)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="socket"></param>
|
|
</member>
|
|
<member name="M:PepperDash.Core.CommStatic.RemoveSocket(PepperDash.Core.ISocketStatus)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="socket"></param>
|
|
</member>
|
|
</members>
|
|
</doc>
|