mobileFX WebSocketX
WebSocketX ActiveX DLL / WebSocket Object
Overview
In This Topic
    WebSocket Object Members
    In This Topic
    Public Methods
    Public Method Close

    Asynchronously close WebSocket connection by transmitting a close code.

    Public Method Open

    Asynchronously open WebSocket connection.

    Public Method Send

    Transmit a String to the WebSocket server.

    Public Method SendBytes

    Transmit a VARIANT of type SafeArray of Bytes to the WebSocket server. 

    Public Method SetCA

    Set CA authority certificate if using a self-signed SSL certificate on the server. 

    Public Method SetHeader

    Set optional headers prior to connection.

    Public Properties
    Public Property AutoFragment

    Set the automatic fragmentation option. Default is false.

    Public Property ConnectTimeoutSec

    Set the connection timeout. Default is 10 sec.

    Public Property EvaluationExpired

    Indicates the evaluation period has expired.

    Public Property IdleTimeoutSec

    The time limit after which a connection is considered idle. Default is 300 sec.

    Public Property MaximumIncomingMessageSizeBytes

    Set the maximum incoming message size option. Default is 10e6.

    Public Property PerMessageDeflateClientEnable

    Set the permessage-deflate extension options. Default is true.

    Public Property PerMessageDeflateCompressionLevel

    Set the permessage-deflate extension options. Default is 3.

    Public Property ProductVersion

    Retrieves product version string.

    Public Property ResolveTimeoutSec

    Set the DNS resolve timeout. Default is 30 sec.

    Public Property State

    Retrieves protocol and connection state.

    Public Property TextMode

    Forces WebSocket protocol into text mode. Default is true.

    Public Property URL

    Retrieves the current WebSocket URL.

    Public Property WorkstationUUID

    Retrieves the Developer Workstation UUID.

    Public Property WriteBufferSizeBytes

    Set the write buffer size option. Default is 10e6.

    Events
    Public Event OnClose

    Fires when WebSocket has been disconnected from server.

    Public Event OnError

    Fires when an error occurs.

    Public Event OnMessage

    Fires when a message is received from the server.

    Public Event OnOpen

    Fires when a WebSocket connection is established.

    See Also

    WebSocket Object

     

     

    mobileFX Studio Ltd

    Send feedback