batch_wrapper.h
Go to the documentation of this file.
/*
Copyright (C) 2024 The University of Notre Dame
This software is distributed under the GNU General Public License.
See the file COPYING for details.
*/
#ifndef BATCH_WRAPPER_H
#define BATCH_WRAPPER_H
#include "batch_job.h"
struct batch_wrapper *batch_wrapper_create(void);
void batch_wrapper_delete(struct batch_wrapper *w);
void batch_wrapper_pre(struct batch_wrapper *w, const char *cmd);
void batch_wrapper_argv(struct batch_wrapper *w, char *const argv[]);
void batch_wrapper_args(struct batch_wrapper *w, char *const args[]);
void batch_wrapper_cmd(struct batch_wrapper *w, const char *cmd);
void batch_wrapper_post(struct batch_wrapper *w, const char *cmd);
void batch_wrapper_prefix(struct batch_wrapper *w, const char *prefix);
char *batch_wrapper_write(struct batch_wrapper *w, struct batch_job *t);
char *batch_wrapper_expand(struct batch_job *t, struct jx *spec);
#endif
/* vim: set noexpandtab tabstop=8: */
batch_job.h
Represents a single batch job.
batch_wrapper_argv
void batch_wrapper_argv(struct batch_wrapper *w, char *const argv[])
Specify a command line to execute in the wrapper.
batch_wrapper_pre
void batch_wrapper_pre(struct batch_wrapper *w, const char *cmd)
Add a shell command to the batch wrapper.
batch_wrapper_expand
char * batch_wrapper_expand(struct batch_job *t, struct jx *spec)
Generate one or more wrapper scripts from a JX command spec.
batch_wrapper_create
struct batch_wrapper * batch_wrapper_create(void)
Create a builder for a batch wrapper.
batch_wrapper_post
void batch_wrapper_post(struct batch_wrapper *w, const char *cmd)
Specify cleanup commands.
batch_wrapper_delete
void batch_wrapper_delete(struct batch_wrapper *w)
Free a batch_wrapper.
batch_wrapper_args
void batch_wrapper_args(struct batch_wrapper *w, char *const args[])
Specify a command line to execute with shell interpretation.
batch_wrapper_cmd
void batch_wrapper_cmd(struct batch_wrapper *w, const char *cmd)
Specify a shell command to execute.
batch_wrapper_write
char * batch_wrapper_write(struct batch_wrapper *w, struct batch_job *t)
Write out the batch_wrapper as a shell script.
batch_wrapper_prefix
void batch_wrapper_prefix(struct batch_wrapper *w, const char *prefix)
Set the name prefix to use for the wrapper script.
batch_job
Internal description of a single batch job submitted to a queue.
Definition batch_job.h:27
jx
JX value representing any expression type.
Definition jx.h:117