console-agent.h 1.71 KB
Newer Older
1 2
/*
 * Copyright (c) 2005 University of Utah and the Flux Group.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 * 
 * {{{EMULAB-LICENSE
 * 
 * This file is part of the Emulab network testbed software.
 * 
 * This file is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 * 
 * This file is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
 * License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this file.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * }}}
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
 */

/**
 * @file console-agent.h
 */

#ifndef _console_agent_h
#define _console_agent_h

#include "event-sched.h"
#include "local-agent.h"

#ifdef __cplusplus
extern "C" {
#endif

#define TIPLOGDIR "/var/log/tiplogs"

/**
 * A local agent structure for Console objects.
 */
struct _console_agent {
	struct _local_agent ca_local_agent;	/*< Local agent base. */
	off_t ca_mark;
};

/**
 * Pointer type for the _console_agent structure.
 */
typedef struct _console_agent *console_agent_t;

/**
 * Create a console agent and intialize it with the default values.
 *
 * @return An initialized console agent object.
 */
console_agent_t create_console_agent(void);

/**
 * Check a console agent object against the following invariants:
 *
 * @li na_local_agent is sane
 *
 * @param na An initialized console agent object.
 * @return True.
 */
int console_agent_invariant(console_agent_t na);

#ifdef __cplusplus
}
#endif

#endif