Click or drag to resize

ServiceBase Class

Base class used to make http requests and responses to a JSON-RPC service.
Inheritance Hierarchy
SystemObject
  SolidFire.CoreServiceBase
    SolidFire.Element.ApiSolidFireElement

Namespace:  SolidFire.Core
Assembly:  SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
Syntax
C#
public class ServiceBase

The ServiceBase type exposes the following members.

Constructors
  NameDescription
Public methodServiceBase
The ServiceBase class handles the HTTP client and requests/responses. It is a JSON-RPC specific HTTP client.
Top
Properties
  NameDescription
Public propertySerializerSettings
Property accessor for JsonSerializerSettings. This can be used to change the way serialization is handled if necessary.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExtractResultTResult
Extract an RPC result from a given string response, using the default serializer settings. This static method can be used to simplify mock testing scenarios for projects built on the SDK.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetConnectionVersion
Get the version number of the underlying connection
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetRequestCount
Returns the number of requests that have been made in the lifetime of this Service. This is used as the id in json-rpc calls unless one is passed in during SendRequestAsync.
Public methodGetTimeout
Return the timespan value of the client's timeout.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUri
Used to retrieve the URI of the request dispatcher.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodResetSerializerSettings
Resets the JsonSerializerSettings back to their defaults which ignores null values.
Public methodSendRequestAsyncTResult(String, CancellationToken, NullableInt32)
Send the Request via Async method and deserialize the result into an expected type. No parameters can be handed to the JSON-RPC remote procedure if using this method.
Public methodSendRequestAsyncTResult(String, Object, CancellationToken, NullableInt32)
Send the Request via Async method and deserialize the result into an expected type.
Public methodSetTimeout
Set the timeout of the HttpClient requests to something other than default.
Public methodSetTimeoutToDefault
Sets the HttpClient timeout to the default.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventOnRequest
This event is fired immediately before the http request is sent.
Public eventOnResponse
This event is fired immediately after the http response is received.
Top
See Also