WebSocketTransport
Namespace: PuppeteerSharp.Transport
public class WebSocketTransport : IConnectionTransport, IDisposableDefault web socket transport.
Inheritance: object
Implements: IConnectionTransport, IDisposable
Constructors
Section titled “Constructors”WebSocketTransport(WebSocket, TransportTaskScheduler, bool)
Section titled “WebSocketTransport(WebSocket, TransportTaskScheduler, bool)”protected WebSocketTransport(WebSocket client, TransportTaskScheduler scheduler, bool queueRequests)Initializes a new instance of the WebSocketTransport class.
Parameters
| Name | Type | Description |
|---|---|---|
client |
WebSocket | The web socket. |
scheduler |
TransportTaskScheduler | The scheduler to use for long-running tasks. |
queueRequests |
bool | Indicates whether requests should be queued. |
Fields
Section titled “Fields”DefaultTransportFactory
Section titled “DefaultTransportFactory”public static readonly TransportFactory DefaultTransportFactoryGets the default WebSocketFactory. This factory does not support Windows 7.
Value: TransportFactory
DefaultTransportScheduler
Section titled “DefaultTransportScheduler”public static readonly TransportTaskScheduler DefaultTransportSchedulerGets the default TransportTaskScheduler.
Value: TransportTaskScheduler
DefaultWebSocketFactory
Section titled “DefaultWebSocketFactory”public static readonly WebSocketFactory DefaultWebSocketFactoryGets the default TransportFactory.
Value: WebSocketFactory
Properties
Section titled “Properties”IsClosed
Section titled “IsClosed”public bool IsClosed { get; }Gets a value indicating whether this IConnectionTransport is closed.
Value: bool
Events
Section titled “Events”Closed
Section titled “Closed”public event EventHandler<TransportClosedEventArgs> ClosedOccurs when the transport is closed.
Value: EventHandler<TransportClosedEventArgs>
MessageReceived
Section titled “MessageReceived”public event EventHandler<MessageReceivedEventArgs> MessageReceivedOccurs when a message is received.
Value: EventHandler<MessageReceivedEventArgs>
Methods
Section titled “Methods”Dispose()
Section titled “Dispose()”public void Dispose()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose(bool)
Section titled “Dispose(bool)”protected virtual void Dispose(bool disposing)Close the WebSocketTransport.
Parameters
| Name | Type | Description |
|---|---|---|
disposing |
bool | Indicates whether disposal was initiated by Dispose() operation. |
SendAsync(byte[])
Section titled “SendAsync(byte[])”public Task SendAsync(byte[] message)Sends a message using the transport.
Parameters
| Name | Type | Description |
|---|---|---|
message |
byte[] | Message to send. |
Returns: Task — The task.
StopReading()
Section titled “StopReading()”public void StopReading()Stops reading incoming data.
Made with love by Dario Kondratiuk