Click or drag to resize

wclSerialClient Class

The serial client class.
Inheritance Hierarchy

Namespace: wclSerialFramework
Assembly: wclSerialFramework (in wclSerialFramework.dll) Version: 8.0.6.0
Syntax
Copy
public class wclSerialClient : wclClientDataConnection

The wclSerialClient type exposes the following members.

Constructors
 NameDescription
Public methodwclSerialClient Creates new serial connection.
Top
Properties
 NameDescription
Public propertyDeviceName Gets a serial device name.
Public propertyMessageProcessing Gets a message processing method.
(Inherited from wclCustomConnection)
Protected propertyReceiver Gets the connection message receiver object.
(Inherited from wclCustomConnection)
Public propertyState Gets the connection state.
(Inherited from wclClientConnection)
Protected propertyThreadId Gets the connection's thread ID.
(Inherited from wclCustomConnection)
Public propertyTimeout Gets and sets the connection timeout.
(Inherited from wclClientConnection)
Public propertyWriteTimeout Gets and sets a write operation timeout.
Top
Methods
 NameDescription
Protected methodCheckState The method checks is the connection state and raises the wclEConnectionActive exception when the connection is active.
(Inherited from wclClientConnection)
Public methodClearCommBreak Restores character transmission for a specified communications device and places the transmission line in a non-break state.
Protected methodConnect(wclMessageProcessingMethod) Starts the connection operation to a remote device.
(Inherited from wclClientConnection)
Public methodConnect(String, wclMessageProcessingMethod) Opens a connection to a specified serial port.
Public methodDisconnect Disconnects from the connected remote device.
(Inherited from wclClientConnection)
Protected methodDoConnect Calls the OnConnect event.
(Inherited from wclClientConnection)
Protected methodDoData Calls the OnData event.
(Inherited from wclClientDataConnection)
Protected methodDoDisconnect Calls the OnDisconnect event.
(Inherited from wclClientConnection)
Protected methodDoError Calls the OnError event.
Protected methodDoEvents Calls the OnEvent event.
Protected methodDoReadError Calls the OnReadError event.
Protected methodEnterCS Enters the connection critical section.
(Inherited from wclCustomConnection)
Public methodEqualsDetermines whether the specified Object is equal to the current Object.
(Inherited from Object)
Public methodEscapeCommFunction Directs the specified communications device to perform an extended function.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFlushBuffers Flushes the buffers and causes all buffered data to be sent to the COM port.
Public methodGetConfig Reads the current serial port settings.
Public methodGetFeatures Reads the serial port features.
Public methodGetHashCodeServes as a hash function for a particular type.
(Inherited from Object)
Public methodGetModemStatus Retrieves the modem control-register values.
Public methodGetReadBufferSize Gets a read buffer size.
(Inherited from wclClientDataConnection)
Public methodGetTimeouts Reads the current serial port timeouts.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetWriteBufferSize Gets a write buffer size.
(Inherited from wclClientDataConnection)
Protected methodHalClearCommBreak Implements a hardware-dependent code that restores character transmission for a specified communications device and places the transmission line in a nonbreak state.
Protected methodHalCommunicate Implements a hardware-dependent code that communicate with a connected remote device.
(Overrides wclClientConnectionHalCommunicate(wclAutoResetEvent))
Protected methodHalConnect Implements a hardware-dependent code that connects to a remote device.
(Overrides wclClientConnectionHalConnect(wclAutoResetEvent))
Protected methodHalDisconnect Implements a hardware-dependent code that disconnects from a connected remote device.
(Overrides wclClientConnectionHalDisconnect)
Protected methodHalEscapeCommFunction Implements a hardware-dependent code that directs the specified communications device to perform an extended function.
Protected methodHalFlushBuffers Implements a hardware-dependent code that flushes the buffers and causes all buffered data to be sent to the COM port.
Protected methodHalGetConfig Implements a hardware-dependent code that reads the current serial port settings.
Protected methodHalGetFeatures Implements a hardware-dependent code that reads the serial port features.
Protected methodHalGetModemStatus Implements a hardware-dependent code that retrieves the modem control-register values.
Protected methodHalGetReadBufferSize Implements a hardware-dependent code that gets a read buffer size.
(Overrides wclClientDataConnectionHalGetReadBufferSize(UInt32))
Protected methodHalGetTimeouts Implements a hardware-dependent code that reads the current serial port timeouts.
Protected methodHalGetWriteBufferSize Implements a hardware-dependent code that gets a write buffer size.
(Overrides wclClientDataConnectionHalGetWriteBufferSize(UInt32))
Protected methodHalPurgeComm Implements a hardware-dependent code that discards all characters from the output or input buffer of a specified communications resource. It can also terminate pending read or write operations on the resource.
Protected methodHalSetCommBreak Implements a hardware-dependent code that suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
Protected methodHalSetConfig Implements a hardware-dependent code that writes the new serial port configuration.
Protected methodHalSetReadBufferSize Implements a hardware-dependent code that sets a read buffer size.
(Overrides wclClientDataConnectionHalSetReadBufferSize(UInt32))
Protected methodHalSetTimeouts Implements a hardware-dependent code that writes the serial port timeouts.
Protected methodHalSetWriteBufferSize Implements a hardware-dependent code that sets a write buffer size.
(Overrides wclClientDataConnectionHalSetWriteBufferSize(UInt32))
Protected methodHalTransmitCommChar Implements a hardware-dependent code that transmits a specified character ahead of any pending data in the output buffer of the specified communications device.
Protected methodHalWrite Implements a hardware-dependent code that sends data to a connected device.
(Overrides wclClientDataConnectionHalWrite(Byte, UInt32))
Protected methodInternalDisconnect The internal disconnect method. Disconnects from a connected remote device.
(Inherited from wclClientConnection)
Protected methodLeaveCS Leaves the connection critical section.
(Inherited from wclCustomConnection)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodMessageReceived The message receiver calls this method when a new notification message is received.
(Overrides wclClientDataConnectionMessageReceived(wclMessage))
Protected methodNotifyClosed Send a Disconnect notification message.
(Inherited from wclClientConnection)
Protected methodNotifyDataReceived Sends a data received notification message.
(Inherited from wclClientDataConnection)
Protected methodPostMessage Places a message to the connection's message receiver queue.
(Inherited from wclCustomConnection)
Public methodPurgeComm Discards all characters from the output or input buffer of a specified communications resource. It can also terminate pending read or write operations on the resource.
Public methodSetCommBreak Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
Public methodSetConfig Writes the new serial port configuration.
Public methodSetReadBufferSize Sets a read buffer size.
(Inherited from wclClientDataConnection)
Public methodSetTimeouts Writes the serial port timeouts.
Public methodSetWriteBufferSize Sets a write buffer size.
(Inherited from wclClientDataConnection)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTransmitCommChar Transmits a specified character ahead of any pending data in the output buffer of the specified communications device.
Public methodWrite Sends a data to a connected device.
(Inherited from wclClientDataConnection)
Top
Events
 NameDescription
Public eventOnConnect The event is called when the connection operation to a remote device is completed.
(Inherited from wclClientConnection)
Public eventOnData The event is called when a data is received from a connected remote device.
(Inherited from wclClientDataConnection)
Public eventOnDisconnect The event fires when the remote connected device has been disconnected.
(Inherited from wclClientConnection)
Public eventOnError The event is called when an error occured during communication.
Public eventOnEvents The event is called when a serial device event occured.
Public eventOnReadError The event is called when an error occurred during read operation.
Top
See Also