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

FreeBSD Manual Pages

  
 
  

home | help
SyslogScan::ByGroup(3)User Contributed Perl DocumentatioSyslogScan::ByGroup(3)

NAME
       SyslogScan::ByGroup -- Organizes	a Summary of mail statistics into
       Groups of related e-mail	users

SYNOPSIS
	   # $summary is a SyslogScan::Summary object

	   # default is	to organize by internet	host
	   my $byGroup = new SyslogScan::ByGroup($summary);
	   print $byGroup -> dump();

	   # group by whether users use	'jupiter' or 'satellife' as
	   # their machine name, and discard users who use neither

	   my $pointerToGroupingRoutine	= sub {
	       my $address = shift;

	       return 'jupiter'	if $address =~ /jupiter.healthnet.org$/;
	       return 'satellife' if $address =~ /satellife.healthnet.org$/;

	       # ignore	all others
	       return undef;
	   }

	   my $groupByMachine =	new SyslogScan::ByGroup($summary,
							$pointerToGroupingRoutine);
	   print $groupByMachine -> dump();

	   # Extract a SyslogScan::Group object
	   my $jupiterGroup = $$groupByMachine{jupiter};
	   print $jupiterGroup -> dump();

	   # Extract a SyslogScan::Summary object
	   my $summaryOfJupiter	= $jupiterGroup{byAddress};
	   print $summaryOfJupiter -> dump();

	   # Create a summary by group,	rather than a summary by address
	   my $summaryByMachine	= $groupByMachine -> createSummary();

DESCRIPTION
       A SyslogScan::ByGroup object is a hash table of SyslogScan::Group
       objects,	each indexed by	the group name as returned by the sorting
       algorithm fed to	'new'.

       A SyslogScan::Group is a	hash table with	two members: 'byAddress',
       which is	a SyslogScan::Summary of each address which is a member	of the
       Group, and 'groupUsage',	which is a SyslogScan::Usage object containing
       the total usage of the group.

AUTHOR and COPYRIGHT
       The author (Rolf	Harold Nelson) can currently be	e-mailed as
       rolf@usa.healthnet.org.

       This code is Copyright (C) SatelLife, Inc. 1996.	 All rights reserved.
       This code is free software; you can redistribute	it and/or modify it
       under the same terms as Perl itself.

       In no event shall SatelLife be liable to	any party for direct,
       indirect, special, incidental, or consequential damages arising out of
       the use of this software	and its	documentation (including, but not
       limited to, lost	profits) even if the authors have been advised of the
       possibility of such damage.

SEE ALSO
       SyslogScan::Summary, SyslogScan::Usage

perl v5.32.0			  1997-11-24		SyslogScan::ByGroup(3)

NAME | SYNOPSIS | DESCRIPTION | AUTHOR and COPYRIGHT | SEE ALSO

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

home | help