flex.messaging.client
Interface EndpointPushHandler

public interface EndpointPushHandler

Defines the interface for a handler that may be registered by an endpoint with a FlexClient in order to push messages to a connected client.

Method Summary

void	close() Invoked to shut down the handler.
void	close(boolean disconnectChannel) Invoked to shut down the handler.
void	pushMessages(List messagesToPush) Invoked by the FlexClient when it has messages to push to the client.
void	registerMessageClient(MessageClient messageClient) Invoked to notify the handler that the MessageClient subscription is using this handler.
void	unregisterMessageClient(MessageClient messageClient) Invoked to notify the handler that a MessageClient subscription that was using it has been invalidated.

Method Detail

close

void close()

Invoked to shut down the handler. It may be invoked by the endpoint when the underlying connection it manages to the client closes, or by the FlexClient if it is invalidated. The implementation of this method should release any resources, and should not attempt to notify the client of an explicit disconnect.

See Also:

EndpointPushHandler.close(boolean)

close

void close(boolean disconnectChannel)

Invoked to shut down the handler. It may be invoked by the endpoint when the underlying connection it manages to the client closes, or by the FlexClient if it is invalidated. The implementation of this method should release any resources, and may attempt to notify the client Channel that it has been disconnected in order to suppress automatic reconnect behavior.

Parameters:

disconnectChannel - True to attempt to notify the client of an explicit disconnect in order to suppress automatic reconnect behavior.

pushMessages

void pushMessages(List messagesToPush)

Invoked by the FlexClient when it has messages to push to the client.

Parameters:

messagesToPush - The list of messages to push.

registerMessageClient

void registerMessageClient(MessageClient messageClient)

Invoked to notify the handler that the MessageClient subscription is using this handler. If subscriptions should be invalidated if the handler is closed, it should retain references to all registered MessageClient instances and invalidate them when it closes.

Parameters:

messageClient - The MessageClient subscription using this handler.

unregisterMessageClient

void unregisterMessageClient(MessageClient messageClient)

Invoked to notify the handler that a MessageClient subscription that was using it has been invalidated. If the handler is tracking the set of MessageClient instances that are using it, the handler should remove the instance from its set.

Parameters:

messageClient - The MessageClient subscription no longer using this handler.