Source: ../../libxorp/status_codes.h

Annotated List Files Globals Hierarchy Index

/* -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*- */

/*
 * Copyright (c) 2001-2003 International Computer Science Institute
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software")
 * to deal in the Software without restriction, subject to the conditions
 * listed in the XORP LICENSE file. These conditions include: you must
 * preserve this copyright notice, and you cannot mention the copyright
 * holders in advertising related to the Software without their permission.
 * The Software is provided WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED. This
 * notice is a summary of the XORP LICENSE file; the license in that file is
 * legally binding.
 */

/*
 * $XORP: xorp/libxorp/status_codes.h,v 1.5 2003/05/29 19:18:27 pavlin Exp $
 */

#ifndef __LIBXORP_STATUS_CODES_H__
#define __LIBXORP_STATUS_CODES_H__

/*
Explanation of Process States
-----------------------------

    +-------------> NULL
    |                |
    |                | (1)
    |                V
    |             STARTUP
    |                |
    |                | (2)
    |                V
    |            NOT_READY
    |             |     ^
    |(7)      (3) |     | (4)
    |             V     |
    |              READY
    |              /   \
    |          (5)/     \(6)
    |            V       V
    |       SHUTDOWN   FAILED
    |            |       |
    |            |       |
    +------------+-------+

Events/Actions
--------------
(1) Register with finder.
(2) External dependencies satisfied, ready to be configured.
(3) Finished processing any config changes, ready for other processes that 
    depend on this process to be configured.
(4) Received a config change that needs to be processed before other 
    processes that depend on this process are configured.
(5) Received a request for a clean shutdown.
(6) Something failed, this process is no longer functioning correctly.
(7) Deregister with finder.

States
------
NULL      Process is not registered with finder.  It may or may not be running.

STARTUP   Process is registered with finder, but is waiting on some other 
          processes before it is ready to be configured.

NOT_READY For any reason, the process is not ready for processes that depend 
          on this process to be configured or reconfigured.  A common reason 
          is that this process just received a config change, and is still 
          in the process of making the config change active.

READY     Process is running normally.  Processes that depend on the state 
          of this process can be configured or reconfigured.

SHUTDOWN  Process has received a shutdown request is shutting down cleanly.  
          Normally the process will terminate by itself after being in this 
          state.

FAILED    Process has suffered a fatal error, and is in the process of 
          cleaning up the mess.  Normally the process will terminate by 
          itself after being in this state.

Notes
-----

A process may spend zero time in STARTUP, NOT_READY, READY, SHUTDOWN or FAILED 
states.  For example, a process may effectively go directly from NULL to 
READY state on startup if there are no dependencies that need to be taken 
into account.  A process may go from STARTUP or NOT_READY states to SHUTDOWN 
or FAILED states without spending any time in READY state if required.

On reconfiguration, a process does not need to go to NOT_READY state unless 
it needs to delay the reconfiguration of processes that depend on the 
completion of this reconfiguration. 

*/

typedef enum {
    PROC_NULL		= 0,
    PROC_STARTUP	= 1,
    PROC_NOT_READY	= 2,
    PROC_READY		= 3,
    PROC_SHUTDOWN	= 4,
    PROC_FAILED		= 5
} ProcessStatus;

#endif /* __LIBXORP_STATUS_CODES_H__ */