KlusterKite.LargeObjects.Client.ParcelNotification Class Reference

Notification about awaiting large object parcel More...

Public Member Functions
Type	GetPayloadType ()
	Gets the type from type name More...
virtual async Task< object >	Receive (ActorSystem system)
	Receives payload from parcel server More...
virtual Task	ReceiveWithPipeTo (ActorSystem system, ICanTell recipient, IActorRef sender)
	Receive parcel's payload and sends it contents to the specified recipient More...

Properties
string	Host [get, set]
	Gets or sets the host name of parcel server More...
int	Port [get, set]
	Gets or sets the port number of parcel server More...
Guid	Uid [get, set]
	Gets or sets the parcel uid More...
string	PayloadTypeName [get, set]
	Gets or sets the parcel payload type name More...
int	ReceiveAttempt [get, set]
	Gets or sets the current receive attempt number More...

Detailed Description

Notification about awaiting large object parcel

Definition at line 27 of file ParcelNotification.cs.

Member Function Documentation

GetPayloadType()

Type KlusterKite.LargeObjects.Client.ParcelNotification.GetPayloadType

(

)

Gets the type from type name

Returns

The type or null, in case this type could not be locally found

Definition at line 61 of file ParcelNotification.cs.

Receive()

virtual async Task<object> KlusterKite.LargeObjects.Client.ParcelNotification.Receive ( ActorSystem  system )

virtual

Receives payload from parcel server

Parameters

system

The actor system

Returns

The payload

Exceptions

TypeLoadException	The type in parcel is unknown to local system
TimeoutException	The timeout occured while reading from stream
ParcelNotFoundException	The parcel was already removed from the server
ParcelServerErrorException	The server could not be contacted or some other error
ParcelServerUnknownStatus	The server returned unknown status

Definition at line 76 of file ParcelNotification.cs.

ReceiveWithPipeTo()

virtual Task KlusterKite.LargeObjects.Client.ParcelNotification.ReceiveWithPipeTo ( ActorSystem  system, ICanTell  recipient, IActorRef  sender  )

virtual

Receive parcel's payload and sends it contents to the specified recipient

Parameters

system	The actor system
recipient	The recipient of the payload and/or exception
sender	The sender

Returns

The executing task

Definition at line 168 of file ParcelNotification.cs.

Property Documentation

Host

string KlusterKite.LargeObjects.Client.ParcelNotification.Host

getset

Gets or sets the host name of parcel server

Definition at line 33 of file ParcelNotification.cs.

PayloadTypeName

string KlusterKite.LargeObjects.Client.ParcelNotification.PayloadTypeName

getset

Gets or sets the parcel payload type name

Definition at line 50 of file ParcelNotification.cs.

Port

int KlusterKite.LargeObjects.Client.ParcelNotification.Port

getset

Gets or sets the port number of parcel server

Definition at line 39 of file ParcelNotification.cs.

ReceiveAttempt

int KlusterKite.LargeObjects.Client.ParcelNotification.ReceiveAttempt

getset

Gets or sets the current receive attempt number

Definition at line 55 of file ParcelNotification.cs.

Uid

Guid KlusterKite.LargeObjects.Client.ParcelNotification.Uid

getset

Gets or sets the parcel uid

Definition at line 45 of file ParcelNotification.cs.

---

The documentation for this class was generated from the following file:

• KlusterKite.LargeObjects/KlusterKite.LargeObjects.Client/ParcelNotification.cs