src/mans/ping_construct.pod

   1 =head1 NAME
   2
   3 ping_construct - Constructor for the liboping class
   4
   5 =head1 SYNOPSIS
   6
   7   #include <oping.h>
   8
   9   pingobj_t *ping_construct (void);
  10   void       ping_destroy   (pingobj_t *obj);
  11
  12 =head1 DESCRIPTION
  13
  14 The B<ping_construct> constructor allocates the memory necessary for a
  15 liboping object, initializes that memory and returns a pointer to it.
  16
  17 The B<ping_destroy> iterates over all hosts associated with the liboping object
  18 I<obj>, closes the sockets, removes the hosts and frees I<obj>'s memory.
  19
  20 =head1 RETURN VALUE
  21
  22 The B<ping_construct> constructor returns a pointer to the allocated memory or NULL if no memory could be allocated.
  23
  24 =head1 SEE ALSO
  25
  26 L<ping_setopt(3)>,
  27 L<ping_send(3)>,
  28 L<ping_host_add(3)>,
  29 L<ping_get_error(3)>,
  30 L<ping_iterator_get(3)>,
  31 L<liboping(3)>
  32
  33 =head1 AUTHOR
  34
  35 liboping is written by Florian "octo" Forster E<lt>octo at verplant.orgE<gt>.
  36 Its homepage can be found at L<http://verplant.org/liboping/>.
  37
  38 Copyright (c) 2005-2011 by Florian "octo" Forster.