Class SinglePacketTransport

Namespace

VpnHood.Net.PacketTransports

Assembly

VpnHood.Net.PacketTransports.dll

Provides a packet transport that queues sent packets and hands them to the derived class one at a time, through SendPacketAsync(IpPacket), on a sending loop of its own.

public abstract class SinglePacketTransport : PacketTransportBase, IPacketTransport, IDisposable

Inheritance

object

PacketTransportBase

SinglePacketTransport

Implements

IPacketTransport

IDisposable

Inherited Members

PacketTransportBase.IsDisposed

PacketTransportBase.IsDisposing

PacketTransportBase.Name

PacketTransportBase.PacketReceived

PacketTransportBase.PacketStat

PacketTransportBase.QueueLength

PacketTransportBase.IsSending

PacketTransportBase.IsSendingBatch

PacketTransportBase.OnPacketReceived(IpPacket)

PacketTransportBase.SendPacketQueuedAsync(IpPacket)

PacketTransportBase.SendPacketQueued(IpPacket)

PacketTransportBase.DropPacket(IpPacket)

PacketTransportBase.LogPacket(IpPacket, Exception, string)

PacketTransportBase.LogPacket(IpPacket, string)

PacketTransportBase.LogPacket(IpPacket, LogLevel, Exception, string, params object[])

PacketTransportBase.Dispose()

PacketTransportBase.Dispose(bool)

PacketTransportBase.PreDispose()

PacketTransportBase.DisposeManaged()

PacketTransportBase.DisposeUnmanaged()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SinglePacketTransport(PacketTransportOptions)

Provides a packet transport that queues sent packets and hands them to the derived class one at a time, through SendPacketAsync(IpPacket), on a sending loop of its own.

protected SinglePacketTransport(PacketTransportOptions options)

Parameters

options PacketTransportOptions

The queue's capacity, blocking and packet disposal.

Exceptions

ArgumentOutOfRangeException

The blocking timeout is negative or too long, or the queue's capacity is not above zero.

Methods

SendPacketAsync(IpPacket)

Sends one packet. A throw drops the packet, so do not throw after handing it on.

protected abstract ValueTask SendPacketAsync(IpPacket ipPacket)

Parameters

ipPacket IpPacket

The packet.

Returns

ValueTask

A task that represents the asynchronous operation.

Exceptions

ArgumentOutOfRangeException

The blocking timeout is negative or too long, or the queue's capacity is not above zero.

SendPacketsAsync(IReadOnlyList<IpPacket>)

Hands the batch's one packet to SendPacketAsync(IpPacket).

protected override sealed ValueTask SendPacketsAsync(IReadOnlyList<IpPacket> ipPackets)

Parameters

ipPackets IReadOnlyList<IpPacket>

The batch: empty, or one packet.

Returns

ValueTask

A task that represents the asynchronous operation.

Exceptions

ArgumentOutOfRangeException

The batch holds more than one packet.