Namespace Neon.Net

Classes

HttpApiException

Thrown by ASP.NET web API implementations to optionally specify an error code that can ultimately be deserialized as the HTTP reason phrase by clients.

HttpException

Describes an HTTP error. These are commonly thrown by JsonClient as well as HTTP clients generated by neon-modelgen.

JsonClient

Implements a light-weight JSON oriented HTTP client.

JsonClientPayload

Passed as the document to be uploaded with a JsonClient POST or PUT request to customize the payload data and content-type. This can be used in special situations where a REST API needs to push application/x-www-form-urlencoded data or other formats.

JsonResponse

Encapsulates the response returned from a JsonClient server call.

Jwt

A lightweight implementation of Json Web Token (JWT) suitable for use by client applications. The JWT structure is described here.

LocalHostSection

Returned by ListLocalHostsSections() holding information about a named section of host entries within the local $/etc/hosts file.

NetConst

Network related constants.

NetHelper

Useful network related utilities.

NetworkCidr

Describes a IP network subnet using Classless Inter-Domain Routing (CIDR) notation.

NetworkConfiguration

Retured by GetNetworkConfiguration() with the current network settings including: Routable IP address, network CIDR, network gateway and the DNS server IP addresses.

NetworkException

Indicates network related problems.

NetworkPorts

Defines some common network port numbers as well as the TryParse(string, out int) method.

Pinger

Implements a threadsafe subset of the .NET Framework Ping class.

ReachableHost

Holds information about a reachable host returned by GetReachableHost(IEnumerable<string>, ReachableHostMode).

StreamDocument

Used by ModelGen generated service client methods to upload body data from a stream as opposed to serializing a document as JSON for service model methods tagged with BodyStreamAttribute.

StreamDocument instances may be passed as the document parameter to JsonClient methods which recognizes these documents as special by uploading the stream data instead of JSON.

note

You may also use special document directly in your code if necessary.

Enums

ReachableHostMode

Enumerates how GetReachableHost(IEnumerable<string>, ReachableHostMode) should behave when no there are no healthy hosts.