com.jpeterson.x10
Interface GatewayListener

All Known Implementing Classes:
GatewayAdapter

public interface GatewayListener
extends java.util.EventListener

Interface defining methods to be called when state-change events for a gateway occur. To receive gateway events an application attaches a listener by calling the addGatewayListener method of an Gateway. A listener is removed by a call to the removeGatewayListener method.

The event dispatch policy is defined in the documentation for the ControlEvent class.

This interface is extended by the ReceiverListener and TransmitterListener interfaces to handle the specialized events of transmitters and receivers.

A trivial implementation of GatewayListener is provided by the GatewayAdapter class. TransmitterAdapter and ReceiverAdapter classes are also available.

See Also:
ControlEvent, GatewayAdapter, TransmitterListener, TransmitterAdapter

Method Summary
 void gatewayAllocated(GatewayEvent e)
          The Gateway has been allocated.
 void gatewayAllocatingResources(GatewayEvent e)
          The Gateway is being allocated.
 void gatewayDeallocated(GatewayEvent e)
          The Gateway has been deallocated.
 void gatewayDeallocatingResources(GatewayEvent e)
          The Gateway is being deallocated.
 void gatewayError(GatewayErrorEvent e)
          An GatewayErrorEvent has occurred and the Gateway is unable to continue normal operation.
 void gatewayPaused(GatewayEvent e)
          The Gateway has been paused.
 void gatewayResumed(GatewayEvent e)
          The Gateway has been resumed.
 

Method Detail

gatewayPaused

public void gatewayPaused(GatewayEvent e)
The Gateway has been paused.
See Also:
GATEWAY_PAUSED

gatewayResumed

public void gatewayResumed(GatewayEvent e)
The Gateway has been resumed.
See Also:
GATEWAY_RESUMED

gatewayAllocated

public void gatewayAllocated(GatewayEvent e)
The Gateway has been allocated.
See Also:
GATEWAY_ALLOCATED

gatewayDeallocated

public void gatewayDeallocated(GatewayEvent e)
The Gateway has been deallocated.
See Also:
GATEWAY_DEALLOCATED

gatewayAllocatingResources

public void gatewayAllocatingResources(GatewayEvent e)
The Gateway is being allocated.
See Also:
GATEWAY_ALLOCATING_RESOURCES

gatewayDeallocatingResources

public void gatewayDeallocatingResources(GatewayEvent e)
The Gateway is being deallocated.
See Also:
GATEWAY_DEALLOCATING_RESOURCES

gatewayError

public void gatewayError(GatewayErrorEvent e)
An GatewayErrorEvent has occurred and the Gateway is unable to continue normal operation.
See Also:
GatewayErrorEvent