From the point of view of the client software, GXClient is the main component of the
GXCom system. A client software can create a media, and change its properties,
through the GXClient object. GXClient steps in also, when starting a media, and when
sending and receiving packets. Because there can be multiple instances of the GXClient
component, the term the GXClient object points to the instance, which makes the call.
Members| All Members | Constructors | Methods | Properties | Events | |
|
|
|
|
|||
| Icon | Member | Description |
|---|---|---|
|
GXClient()()() |
Initializes a new instance of the GXClient class
|
|
|
AboutBox()()() |
Displays the copyright of the control, user license, and version information, in a dialog box.
|
|
|
AssignMedia(Object) |
Assigns new media, after media settings are changed.
|
|
BufferSize |
Retrieves or sets the packet buffer size.
|
|
|
ByteOrder |
Retrieves or sets the byte order.
|
|
|
BytesReceived |
Returns the amount of received bytes.
|
|
|
BytesSent |
Returns the amount of sent bytes.
|
|
CanRaiseEvents |
Gets a value indicating whether the component can raise an event.
(Inherited from Component.) |
|
|
Clone()()() |
Creates a copy of the client.
|
|
|
Close()()() |
Closes the connection to the GXCom.
The used media is not closed, if there is more than one client that uses GXCom.
The media is closed, when the last GXClient closes connection.
It is recommended to use Close method, instead of MediaClose.
|
|
|
Container |
Gets the IContainer that contains the Component.
(Inherited from Component.) |
|
|
CreateObjRef(Type) |
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.) |
|
|
CreatePacketPool(Int32, Int32) |
Creates a packet pool.
|
|
|
DataSize |
Retrieves the size of the data part.
|
|
|
DesignMode |
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.) |
|
|
DeviceID |
Retrieves or sets the device identifier.
|
|
|
Dirty |
Retrieves or sets, whether the media has been modified, since the last time it was saved.
|
|
Dispose(Boolean) | (Overrides Component.Dispose(Boolean).) |
|
|
Dispose()()() |
Releases all resources used by the Component.
(Inherited from Component.) |
|
Disposed |
Occurs when the component is disposed by a call to the Dispose()()() method.
(Inherited from Component.) |
|
|
EnumMedias(Int32) |
Enumerates available medias.
|
|
|
Equals(Object) |
Determines whether two objects are equal.
(Overrides Object.Equals(Object).) |
|
|
Events |
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.) |
|
|
Finalize()()() |
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.) |
|
|
FreePacketCount |
Returns the count of the free packets, in the packet pool.
|
|
|
GetAvailableLocaleIdentifiers()()() |
Returns collection of available locale identifiers.
|
|
|
GetAvailableMedias()()() |
Returns string collection of available media types.
|
|
|
GetBOP(Object%, VariantType%) |
Gets the BOP (Beginning of the packet), and the BOP type.
|
|
|
GetChecksumParameters(Int32%, Checksum%, Int32%, Int32%, Int32%, Int32%, Int32%, Int32%, Boolean%, Boolean%) |
Gets the current checksum parameters. Media must be selected before using this method.
|
|
|
GetCompression(Int32%, Int32%) |
Retrieves the compression information.
|
|
|
GetCurrentMedia()()() |
Returns the active media.
|
|
|
GetDataSizeInHeader(Int32%, VariantType%) |
This method is reserved for future use, and should not be used.
|
|
|
GetDirectMedia()()() |
Direct access to active media.
|
|
|
GetEOP(Object%, VariantType%) |
Gets the EOP (End of the packet), and the EOP type.
|
|
|
GetFreePacket(Int32) |
Gets the next free packet, from the packet pool.
|
|
|
GetHashCode()()() |
Serves as a hash function for a particular type.
(Overrides Object.GetHashCode()()().) |
|
|
GetInitializeData(Initialize) |
Retrieves Initializing data.
|
|
|
GetLifetimeService()()() |
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.) |
|
|
GetMediaCount()()() |
Returns the number of available medias.
|
|
GetOcx()()() |
Retrieves a reference to the underlying ActiveX control.
|
|
|
GetPacketId(Int32%, VariantType%) |
Gets the position, and the type, of the packet ID.
|
|
|
GetParallelClients()()() |
Retrieves collection of the other clients, who share the same server.
|
|
|
GetReplyBOP(Object%, VariantType%) |
Gets the BOP (Beginning of the packet), and the BOP type, of the reply data.
|
|
|
GetReplyEOP(Object%, VariantType%) |
Gets the EOP (End of the packet), and the EOP type, of the reply data.
|
|
|
GetScriptParser()()() |
Retrieves script parser.
|
|
|
GetService(Type) |
(Inherited from Component.) |
|
|
GetSettings(Boolean) |
Gets the client settings as an XML string.
|
|
|
GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
|
|
HeaderSize |
Retrieves the size of the header part.
|
|
|
ID |
Object Identifier.
|
|
|
IdentificationMode |
Device identification mode.
|
|
|
InitializeLifetimeService()()() |
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.) |
|
|
IsConnected |
Checks if the GXClient object is already connected to a media component.
|
|
|
LoadSettings(Boolean, String, Boolean) |
Loads default media settings from a registry.
|
|
|
LocaleIdentifier |
Retrieves or sets used locale identifier. Used language is set with the locale identifier.
Use GetAvailableLocaleIdentifiers to query language support.
To use default language set value to zero.
|
|
|
MediaClose()()() |
Closes the active media.
|
|
|
MediaIsOpen |
Returns True, if the media is currently open.
|
|
|
MediaLoadSettings(String, Boolean) |
Loads the default media settings from a registry.
|
|
|
MediaName |
Retrieves the name of the media.
|
|
|
MediaOpen()()() |
Opens the selected media.
|
|
|
MediaProperties(IWin32Window) |
Shows and changes the properties of the active media.
|
|
|
MediaSaveSettings(String, Boolean) |
Saves Media settings to a registry.
|
|
|
MediaType |
Returns the type of the media.
|
|
|
MediaTypeAsString |
Retrieves the type of the media, as string.
|
|
|
MemberwiseClone(Boolean) |
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.) |
|
|
MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
|
|
OnAcceptClient |
Called, when the client is establishing a connection with a server.
|
|
|
OnClientConnected |
Called, when the client is establishing a connection with a server.
|
|
|
OnClientDisconnected |
Called, when the client has been disconnected from the GXNet server.
|
|
|
OnCountChecksum |
GXClient component calls this method, when the checksum is counted.
|
|
|
OnDirty |
Called, when the client or media settings are modified.
|
|
|
OnError |
Errors that occur after the connection is established are sent through this method.
|
|
|
OnGetClientByConnectionData |
Called when new client has send handshake information.
|
|
|
OnIsReplyPacket |
GXClient component calls this method, when it checks, if the received packet is a reply packet.
|
|
|
OnIsReplyPacketOK |
GXClient component uses this method to check that the content of the response packet is not damaged.
|
|
|
OnMediaStateChange |
This method is used to send information, when media state is changed.
|
|
|
OnPacketsInBuffer |
GXClient component calls this method every time a new packet is sent or received.
|
|
|
OnParsePacketFromData |
GXClient component calls this method, if the client application uses its own parsing method instead of the one of GXCom.
|
|
|
OnReceived |
GXClient component sends all asynchronous and notification packets using this method.
|
|
|
OnReceiveData |
This method is used to identify the correct data.
|
|
|
PacketCount |
Returns the count of the packets, in the packet pool.
|
|
|
PacketsInBuffer(Int32%, Int32%, Int32%) |
Retrieves the number of packets in the buffer.
|
|
|
PacketsReceived |
The amount of received packets.
|
|
|
PacketsSent |
The amount of sent packets.
|
|
|
PacketType |
Retrieves or sets the Packet Type.
|
|
|
ParseReceivedPacket |
Retrieves or sets a Boolean to indicate, if the application parses the received packets.
|
|
|
Properties(IWin32Window, Boolean) |
Shows and changes the properties of the protocol.
|
|
|
ReleasePacket(GXPacket) |
Returns a reserved packet back to the packet pool.
|
|
|
ResendCount |
Retrieves or sets the resend count of the packet.
|
|
|
ResetBuffers()()() |
Resets sender and receiver buffers.
|
|
|
ResetByteCounters()()() |
Resets BytesReceived and BytesSent counters.
|
|
|
ResetPacketCounters()()() |
Resets PacketsSent and PacketsReceived counters.
|
|
|
SaveSettings(Boolean, String, Boolean) |
Saves media settings to the registry.
|
|
|
ScriptFile |
Retrieves or sets the script file.
|
|
|
ScriptLanguage |
Retrieves or sets the script language. By default, the script language is VBScript.
|
|
|
SelectMedia(String) |
Selects the Media.
|
|
|
Send(GXPacket, Boolean, String) |
Sends the packet.
|
|
|
SetBOP(Object, VariantType) |
Sets the BOP (Beginning of the packet), and the BOP type.
|
|
|
SetChecksumParameters(Int32, Checksum, Int32, Int32, Int32, Int32, Int32, Int32, Boolean, Boolean) |
Sets the parameters needed to calculate the checksum.
Note: Parameters CRCSize, CRCPolynomial, CRCInitialValue, CRCFinalXOR, CRCReverseData
and/or CRCReflection can be used only, when ChkType is Custom (GX_CHK_CUSTOM).
|
|
|
SetCompression(CompressType, Int32, Int32) |
Sets information of compression.
|
|
|
SetDataSizeInHeader(Int32, VariantType) |
This method is reserved for future use, and should not be used.
|
|
|
SetEOP(Object, VariantType) |
Sets the EOP (End of the packet), and EOP type.
|
|
|
SetInitializeData(Initialize, Object) |
Sets Initializing data.
|
|
|
SetPacketId(Int32, VariantType) |
Sets the position, and the type, of the packet ID.
|
|
|
SetReplyBOP(Object, VariantType) |
Sets the BOP BOP (Beginning of the packet), and the BOP type, of the reply data.
|
|
|
SetReplyEOP(Object, VariantType) |
Sets the EOP (End of the packet), and the EOP type, of the reply data.
|
|
|
SetSettings(String) |
Sets client settings as an XML string.
|
|
|
Site |
(Inherited from Component.) |
|
|
ToString()()() |
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.) |
|
|
WaitTime |
Retrieves or sets the waiting time of the packet.
|
Inheritance Hierarchy| Object | |||
|
MarshalByRefObject | ||
|
|
Component | ||
|
|
GXClient | ||
Assembly: Gurux.Client (Module: Gurux.Client) Version: 5.0.0.1