ad2435fb b776 6a2f 4e05 257d143d1edb

Consumer(TPack) Class

Describes the class that will be responsible for consuming the packages, meaning it will build packages with the buffers published by a publisher and will launch an event for every pack to be treated.

Inheritance Hierarchy

System.Object
  NETLIB.Consumer(TPack)
    NETLIB.IOPackHandler(TPack)
Namespace: NETLIB
Assembly: NETLIB (in NETLIB.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#

public abstract class Consumer<TPack> : IDisposable
where TPack : BasePack

VB

Public MustInherit Class Consumer(Of TPack As BasePack)
	Implements IDisposable

C++

generic<typename TPack>
where TPack : BasePack
public ref class Consumer abstract : IDisposable

F#

[<AbstractClassAttribute>]
type Consumer<'TPack when 'TPack : BasePack> =  
    class
        interface IDisposable
    end

Type Parameters

 

TPack

Pack class derived from BasePack that the Consumer will manage.

  The Consumer(TPack) type exposes the following members.

Constructors

 

	Name	Description
	Consumer(TPack)	Initializes the consumer with a publisher and define the initial settings.

  Back to Top

Properties

 

	Name	Description
	IsEnabled	Boolean indicating when the consumption of packages is active.
	IsPublishEnabled	Boolean indicating whether the publisher is currently active, publishing packages.
	Publisher	Returns the publisher being consumed.

  Back to Top

Methods

 

	Name	Description
	CloseConnection	Closes the publisher connection.
	Dispose	Ends the consumption of paks without changing the status of the publisher.
	EndConsume	Stops the pack consumption thread.
	EndPublishConsume	Stops the publisher and the pack consumption thread.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Ends the consumption of paks without changing the status of the publisher, in the death of the object, if the Dispose method was not used properly. (Overrides Object.Finalize().)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnReceivedPackCall	Calls ReceivedPack for treatment and consumption of a incoming package.
	PackFactory()	Used by the Consume() to obtain an instance of the TPack through BasePack() constructor.
	PackFactory(Byte[])	Used by the Consume() to obtain an instance of the TPack through BasePack(Byte[]) constructor.
	PackFactory(BasePack)	Used by the Consume() to obtain an instance of the TPack through BasePack(BasePack) constructor.
	SendPack(Byte[], IPEndPoint)	Sends the packet through the publisher
	SendPack(TPack, IPEndPoint)	Sends the packet through the publisher
	Start	Starts the publisher and the thread of consumption of packs.
	StartConsume	Starts the thread of consumption of packs.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

  Back to Top

Events

 

	Name	Description
	ConnectionClosed	Event used to signal when the connection (input stream) was closed for any reason.
	ReceivedPack	Event called for treatment and consumption of a incoming pack.

  Back to Top

See Also

Reference

NETLIB Namespace
NETLIB.BasePack
NETLIB.Publisher
NETLIB.ThrowPackEventHandler(TPack)