pinger.h File Reference

ICMP ping sender. More...

#include <stdint.h>
#include <ipxe/interface.h>
#include <ipxe/socket.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	create_pinger (struct interface *job, const char *hostname, unsigned long timeout, size_t len, unsigned int count, void(*callback)(struct sockaddr *peer, unsigned int sequence, size_t len, int rc))
	Create pinger.

Detailed Description

ICMP ping sender.

Definition in file pinger.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

References count, len, peer, rc, and timeout().

create_pinger()

int create_pinger ( struct interface * job, const char * hostname, unsigned long timeout, size_t len, unsigned int count, void(* callback )(struct sockaddr *src, unsigned int sequence, size_t len, int rc) )

extern

Create pinger.

Parameters

job	Job control interface
hostname	Hostname to ping
timeout	Timeout (in ticks)
len	Payload length
count	Number of packets to send (or zero for no limit)
callback	Callback function (or NULL)

Return values

rc	Return status code

Definition at line 313 of file pinger.c.

                                                     {
        struct pinger *pinger;
        int rc;
 
        /* Sanity check */
        if ( ! timeout )
                return -EINVAL;
 
        /* Allocate and initialise structure */
        pinger = zalloc ( sizeof ( *pinger ) );
        if ( ! pinger )
                return -ENOMEM;
        ref_init ( &pinger->refcnt, NULL );
        intf_init ( &pinger->job, &pinger_job_desc, &pinger->refcnt );
        intf_init ( &pinger->xfer, &pinger_xfer_desc, &pinger->refcnt );
        timer_init ( &pinger->timer, pinger_expired, &pinger->refcnt );
        pinger->timeout = timeout;
        pinger->len = len;
        pinger->remaining = ( count ? ( count + 1 /* Initial packet */ ) : 0 );
        pinger->callback = callback;
        pinger->rc = -ETIMEDOUT;
 
        /* Open socket */
        if ( ( rc = xfer_open_named_socket ( &pinger->xfer, SOCK_ECHO, NULL,
                                             hostname, NULL ) ) != 0 ) {
                DBGC ( pinger, "PINGER %p could not open socket: %s\n",
                       pinger, strerror ( rc ) );
                goto err;
        }
 
        /* Attach parent interface, mortalise self, and return */
        intf_plug_plug ( &pinger->job, job );
        ref_put ( &pinger->refcnt );
        return 0;
 
 err:
        pinger_close ( pinger, rc );
        ref_put ( &pinger->refcnt );
        return rc;
}

References pinger::callback, count, DBGC, EINVAL, ENOMEM, ETIMEDOUT, intf_init(), intf_plug_plug(), pinger::job, len, pinger::len, NULL, pinger_close(), pinger_expired(), pinger_job_desc, pinger_xfer_desc, pinger::rc, rc, ref_init, ref_put, pinger::refcnt, pinger::remaining, SOCK_ECHO, src, strerror(), pinger::timeout, timeout(), pinger::timer, pinger::xfer, xfer_open_named_socket(), and zalloc().

Referenced by ping().