ping_cmd.c File Reference

Ping command. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <getopt.h>
#include <ipxe/command.h>
#include <ipxe/parseopt.h>
#include <ipxe/timer.h>
#include <usr/pingmgmt.h>

Go to the source code of this file.

Data Structures
struct	ping_options
	"ping" options More...

Macros
#define	PING_DEFAULT_SIZE   64
	Default payload length.
#define	PING_DEFAULT_TIMEOUT   TICKS_PER_SEC
	Default timeout.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	ping_exec (int argc, char **argv)
	The "ping" command.
	COMMAND (ping, ping_exec)
	Ping command.

Variables
static struct option_descriptor	ping_opts []
	"ping" option list
static struct command_descriptor	ping_cmd
	"ping" command descriptor

Detailed Description

Ping command.

Definition in file ping_cmd.c.

Macro Definition Documentation

PING_DEFAULT_SIZE

#define PING_DEFAULT_SIZE   64

Default payload length.

Definition at line 45 of file ping_cmd.c.

Referenced by ping_exec().

PING_DEFAULT_TIMEOUT

#define PING_DEFAULT_TIMEOUT   TICKS_PER_SEC

Default timeout.

Definition at line 48 of file ping_cmd.c.

Referenced by ping_exec().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

ping_exec()

int ping_exec ( int argc, char ** argv )

static

The "ping" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 85 of file ping_cmd.c.

                                               {
        struct ping_options opts;
        const char *hostname;
        int rc;
 
        /* Initialise options */
        memset ( &opts, 0, sizeof ( opts ) );
        opts.size = PING_DEFAULT_SIZE;
        opts.timeout = PING_DEFAULT_TIMEOUT;
 
        /* Parse options */
        if ( ( rc = reparse_options ( argc, argv, &ping_cmd, &opts ) ) != 0 )
                return rc;
 
        /* Parse hostname */
        hostname = argv[optind];
 
        /* Ping */
        if ( ( rc = ping ( hostname, opts.timeout, opts.size,
                           opts.count, opts.quiet ) ) != 0 )
                return rc;
 
        return 0;
}

References memset(), optind, opts, ping(), ping_cmd, PING_DEFAULT_SIZE, PING_DEFAULT_TIMEOUT, rc, and reparse_options().

Referenced by COMMAND().

COMMAND()

COMMAND	(	ping	,
		ping_exec	)

Ping command.

References ping(), and ping_exec().

Variable Documentation

ping_opts

struct option_descriptor ping_opts[]

static

Initial value:

= {
        OPTION_DESC ( "size", 's', required_argument,
                      struct ping_options, size, parse_integer ),
        OPTION_DESC ( "timeout", 't', required_argument,
                      struct ping_options, timeout, parse_timeout ),
        OPTION_DESC ( "count", 'c', required_argument,
                      struct ping_options, count, parse_integer ),
        OPTION_DESC ( "quiet", 'q', no_argument,
                      struct ping_options, quiet, parse_flag ),
}

"ping" option list

Definition at line 63 of file ping_cmd.c.

                                              {
        OPTION_DESC ( "size", 's', required_argument,
                      struct ping_options, size, parse_integer ),
        OPTION_DESC ( "timeout", 't', required_argument,
                      struct ping_options, timeout, parse_timeout ),
        OPTION_DESC ( "count", 'c', required_argument,
                      struct ping_options, count, parse_integer ),
        OPTION_DESC ( "quiet", 'q', no_argument,
                      struct ping_options, quiet, parse_flag ),
};

ping_cmd

struct command_descriptor ping_cmd

static

Initial value:

=
        COMMAND_DESC ( struct ping_options, ping_opts, 1, 1, "<host>" )

"ping" command descriptor

Definition at line 75 of file ping_cmd.c.

Referenced by ping_exec(), and PROVIDE_REQUIRING_SYMBOL().