Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ping_host_add(3)		   liboping		      ping_host_add(3)

NAME
       ping_host_add - Add a host to a liboping	object

SYNOPSIS
	 #include <oping.h>

	 int ping_host_add    (pingobj_t *obj, const char *host);
	 int ping_host_remove (pingobj_t *obj, const char *host);

DESCRIPTION
       The ping_host_add method	tries to resolve the host argument, open a
       socket and associate everything with the	liboping object	obj.

       The obj argument	is a pointer to	an liboping object, as returned	by
       ping_construct(3).

       The host	parameter is a '\0' terminated string which is interpreted as
       a hostname or an	IP address. Depending on the address family setting,
       set with	ping_setopt(3),	the hostname is	resolved to an IPv4 or IPv6
       address.

       The ping_host_remove method looks for host within obj and remove	it if
       found. It will close the	socket and deallocate the memory, too.

       The names passed	to ping_host_add and ping_host_remove must match. This
       name can	be queried using ping_iterator_get_info(3).

RETURN VALUE
       If ping_host_add	succeeds it returns zero. If an	error occurs a value
       less than zero is returned and the last error is	saved internally. You
       can receive the error message using ping_get_error(3).

       ping_host_remove	returns	zero upon success and less than	zero if	it
       failed.	Currently the only reason for failure is that the host isn't
       found, but this is subject to change. Use ping_get_error(3) to receive
       the error message.

SEE ALSO
       ping_construct(3), ping_setopt(3), ping_get_error(3), liboping(3)

AUTHOR
       liboping	is written by Florian "octo" Forster <octo at verplant.org>.
       Its homepage can	be found at <http://verplant.org/liboping/>.

       Copyright (c) 2005-2011 by Florian "octo" Forster.

1.6.2				  2011-09-06		      ping_host_add(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=ping_host_add&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help