Visit Platform at http://www.platform.com

Platform Symphony 4.1 Java API Reference

com.platform.symphony.soam
Interface InterruptEvent


public interface InterruptEvent

An object that encapsulates the following information:

  • an event code, to determine the type of event that occurred
  • a grace period, which indicates how much time the service will have to react to the event before being forcefully killed
  • Get the last InterruptEvent from the ServiceContext.

    See Also:
    ServiceContext.getLastInterruptEvent()

    Field Summary
    static int NONE
              Event code indicating that no interrupt event has occurred.
    static int SESSION_KILLED
              Deprecated. As of Symphony 4.0, replaced by TASK_KILLED
    static int SESSION_SUSPENDED
              Deprecated. As of Symphony 4.0, replaced by TASK_SUSPENDED
    static int TASK_KILLED
              Event code indicating that the service will be interrupted because the task is being killed.
    static int TASK_SUSPENDED
              Event code indicating that the service will be interrupted because the task is being suspended.
     
    Method Summary
     int getInterruptEventCode()
              Returns the interrupt event code.
     long getInterruptGracePeriod()
              Returns the interrupt grace period.
     

    Field Detail

    NONE

    static final int NONE
    Event code indicating that no interrupt event has occurred.

    See Also:
    Constant Field Values

    SESSION_KILLED

    static final int SESSION_KILLED
    Deprecated. As of Symphony 4.0, replaced by TASK_KILLED
    Event code indicating that the service will be interrupted because the Task is being killed.

    See Also:
    Constant Field Values

    SESSION_SUSPENDED

    static final int SESSION_SUSPENDED
    Deprecated. As of Symphony 4.0, replaced by TASK_SUSPENDED
    Event code indicating that the service will be interrupted because the Task is being suspended.

    See Also:
    Constant Field Values

    TASK_KILLED

    static final int TASK_KILLED
    Event code indicating that the service will be interrupted because the task is being killed. Any data or exception returned from the interrupted operation will be handled in the normal manner by the middleware.

    See Also:
    Constant Field Values

    TASK_SUSPENDED

    static final int TASK_SUSPENDED
    Event code indicating that the service will be interrupted because the task is being suspended. Any data or exception returned from the interrupted operation will be handled in the normal manner by the middleware.

    See Also:
    Constant Field Values
    Method Detail

    getInterruptEventCode

    int getInterruptEventCode()
    Returns the interrupt event code. Value can be one of:

    getInterruptGracePeriod

    long getInterruptGracePeriod()
    Returns the interrupt grace period. The service will have this much time in which to clean up, before being forcefully killed.

    Returns:
    The interrupt grace period

    Version 4.1
    Date Modified: -DREL_DATE=Nov 03 2008
    Platform Computing. Accelerating Intelligence(TM).
    Copyright (C) 2001-2008 Platform Computing Corporation. All rights reserved.