C# Class Akka.Remote.Transport.Transport

Show file Open project: rogeralsing/akka.net Class Usage Examples

Public Methods

Method Description
Associate ( Akka.Actor.Address remoteAddress ) : Task

Asynchronously opens a logical duplex link between two Transport entities over a network. It could be backed with a real transport layer connection (TCP), socketless connections provided over datagram protocols (UDP), and more. This call returns a Task of an AssociationHandle. A faulted Task indicates that the association attempt was unsuccessful. If the exception is InvalidAssociationException then the association request was invalid and it's impossible to recover.

IsResponsibleFor ( Akka.Actor.Address remote ) : bool
Listen ( ) : TaskCompletionSource>>.Task
ManagementCommand ( object message ) : Task

This method allows upper layers to send management commands to the transport. It is the responsibility of the sender to send appropriate commands to different transport implementations. Unknown commands will be ignored.

Shutdown ( ) : Task

Shuts down the transport layer and releases all of the corresponding resources. Shutdown is asynchronous and is signaled by the result of the returned Task. The transport SHOULD try flushing pending writes before becoming completely closed.

Method Details

Associate() public abstract method

Asynchronously opens a logical duplex link between two Transport entities over a network. It could be backed with a real transport layer connection (TCP), socketless connections provided over datagram protocols (UDP), and more. This call returns a Task of an AssociationHandle. A faulted Task indicates that the association attempt was unsuccessful. If the exception is InvalidAssociationException then the association request was invalid and it's impossible to recover.
public abstract Associate ( Akka.Actor.Address remoteAddress ) : Task
remoteAddress Akka.Actor.Address The address of the remote transport entity.
return Task

IsResponsibleFor() public abstract method

public abstract IsResponsibleFor ( Akka.Actor.Address remote ) : bool
remote Akka.Actor.Address
return bool

Listen() public abstract method

public abstract Listen ( ) : TaskCompletionSource>>.Task
return TaskCompletionSource>>.Task

ManagementCommand() public method

This method allows upper layers to send management commands to the transport. It is the responsibility of the sender to send appropriate commands to different transport implementations. Unknown commands will be ignored.
public ManagementCommand ( object message ) : Task
message object Command message to send to the transport.
return Task

Shutdown() public abstract method

Shuts down the transport layer and releases all of the corresponding resources. Shutdown is asynchronous and is signaled by the result of the returned Task. The transport SHOULD try flushing pending writes before becoming completely closed.
public abstract Shutdown ( ) : Task
return Task