com.neeve.link.multi
Class LnkMultiClientEndpoint

java.lang.Object
  com.neeve.root.RootObject
      com.neeve.link.multi.LnkMultiObject
          com.neeve.link.multi.LnkMultiClientEndpoint

All Implemented Interfaces:

ILnkClientEndpointCore

public final class LnkMultiClientEndpoint
extends LnkMultiObject
implements ILnkClientEndpointCore

Multi link client endpoint class.

This class is the client endpoint class for the multi link type. An instance of this class is wrapped by the LnkClientEndpoint to provide a full implementation of ILnkClientEndpoint for the multi link type.

Method Summary

void	close() Implementation of ILnkClientEndpointCore.close()
void	connectCancel(int flags) Implementation of ILnkClientEndpointCore.connectCancel(int)
void	connectPost(IEmxDispatcher dispatcher, ILnkEventHandlerCore handler, int flags) Implementation of ILnkClientEndpointCore.connectPost(com.neeve.emx.IEmxDispatcher, com.neeve.link.ILnkEventHandlerCore, int)
static ILnkClientEndpoint	create(com.neeve.util.UtlAddressDescriptor descriptor) Create a multi link client endpoint

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer, setChecked, setTracer

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ILnkClientEndpoint create(com.neeve.util.UtlAddressDescriptor descriptor)
                                 throws ELnkException

Create a multi link client endpoint

Parameters:

descriptor - An address descriptor object containing the address and configuration properties to use in creating the endpoint.

Throws:

ELnkException

connectPost

public final void connectPost(IEmxDispatcher dispatcher,
                              ILnkEventHandlerCore handler,
                              int flags)
                       throws ELnkOpFailedException

Implementation of ILnkClientEndpointCore.connectPost(com.neeve.emx.IEmxDispatcher, com.neeve.link.ILnkEventHandlerCore, int)

Specified by:

connectPost in interface ILnkClientEndpointCore

Parameters:

dispatcher - The dispatcher in whose context the completion event is to be dispatched. The user will ensure that the the invoking thread is the owner of this dispatcher.

handler - The event handler to which the completion event is to be dispatched.

flags - Flags that qualify the connect operation. The following flags can be set on invocation of this method:
- ILnkEndpoint.IOFLAG_NO_ASYNC: In case this flag is specified and the connect operation could not be completed prior to return from this call, the method should not schedule the connect for asynchronous completion and just return without throwing any exception.

Throws:

ELnkOpFailedException - This exception should be thrown in case a failure was encountered in the establishment of the connection.

See Also:

ILnkClientEndpointCore.connectCancel(int)

connectCancel

public final void connectCancel(int flags)

Implementation of ILnkClientEndpointCore.connectCancel(int)

Specified by:

connectCancel in interface ILnkClientEndpointCore

Parameters:

flags - Flags that qualify the connect cancellation operation. Currently, there are no supported flags for use, This parameter is present for future use. The user will always specify a value of 0 in this parameter.

This method should cancel a previously posted connect operation. A successful return from this method indicates that the connect operation has been cancelled. No completion event for the connect should be dispatched once the connect has been cancelled.

See Also:

ILnkClientEndpointCore.connectPost(com.neeve.emx.IEmxDispatcher, com.neeve.link.ILnkEventHandlerCore, int)

close

public final void close()
                 throws ELnkOpFailedException

Implementation of ILnkClientEndpointCore.close()

Specified by:

close in interface ILnkClientEndpointCore

Throws:

ELnkOpFailedException - This exception should be thrown in case an error was encountered while closing the endpoint.

This method is used to close an unconnected client endpoint and release all operating system resources allocated to the client endpoint. This method will never be invoked on a connecting or connected endpoint. The purpose of this method is to release all underlying resources upon abandonment of the connection establishment process.