PollingRequestHandler Class
.NET Framework 4.5
Represents a polling request handler.
Inheritance Hierarchy
System.Object
Microsoft.AspNet.SignalR.Client.Transports.PollingRequestHandler
Namespace: Microsoft.AspNet.SignalR.Client.Transports
Assembly: Microsoft.AspNet.SignalR.Client (in Microsoft.AspNet.SignalR.Client.dll)
Syntax
'Declaration
Public Class PollingRequestHandler
'Usage
Dim instance As PollingRequestHandler
public class PollingRequestHandler
public ref class PollingRequestHandler
type PollingRequestHandler = class end
public class PollingRequestHandler
The PollingRequestHandler type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.jpeg "Public method") |
PollingRequestHandler | Initializes a new instance of the PollingRequestHandler class. |
Top
Properties
| Name | Description | |
|---|---|---|
.jpeg "Public property") |
OnAfterPoll | Gets or sets a function that triggers before a new polling request is attempted. Passes in an exception if the Poll errored, null reference (Nothing in Visual Basic) otherwise. Expects the return as a task in order to allow modification of timing for subsequent polls. |
|
ResolveUrl | Gets or sets a function used to generate the URL that is posted to for the poll. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
.jpeg "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
Start | Starts the polling request handler. |
|
Stop | Fully stops the polling request handler. |
|
ToString | (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.jpeg "Public event") |
OnAbort | Occurs when the current poll request was aborted, passing in the soon to be aborted request. |
|
OnError | Occurs and passes the exception when the poll errors. |
|
OnMessage | Sends the string based message to the callback. |
|
OnPolling | Occurs when the polling request is in flight. |
|
PrepareRequest | Allows modification of the IRequest parameter before using it in a poll. |
Top
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.