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

FreeBSD Manual Pages

  
 
  

home | help
ping_iterator_get_context(3)	   liboping	  ping_iterator_get_context(3)

NAME
       ping_iterator_get_context, ping_iterator_set_context - Store
       host-dependent data

SYNOPSIS
	 #include <oping.h>

	 void *ping_iterator_get_context (pingobj_iter_t *iter);
	 void  ping_iterator_set_context (pingobj_iter_t *iter,	void *context);

DESCRIPTION
       ping_iterator_set_context can be	used to	store host-specific data
       within the liboping structures. This data can be	received again by
       calling ping_iterator_get_context. The data itself is never touched by
       liboping. If you	call ping_host_remove (see ping_host_add(3)) or
       ping_destroy (see ping_construct(3)) and	the context is not NULL
       liboping	will assume you	know what you're doing and simply ignore the
       fact this might be a memory leak.

       The iter	argument is an iterator	object as returned by
       ping_iterator_get(3) and	ping_iterator_next.

       The context argument of ping_iterator_set_context is a pointer to
       anything	and may	be NULL.

RETURN VALUE
       ping_iterator_get_context returns the same pointer previously passed to
       ping_iterator_set_context or NULL if ping_iterator_set_context has
       never been called before.

SEE ALSO
       ping_iterator_get(3), ping_construct(3),	ping_host_add(3), liboping(3)

AUTHOR
       liboping	is written by Florian "octo" Forster <ff at octo.it>.  Its
       homepage	can be found at	<http://noping.cc/>.

       Copyright (c) 2006-2017 by Florian "octo" Forster.

1.10.0				  2017-05-11	  ping_iterator_get_context(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ping_iterator_get_context&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help