M. Lawrence Weikum > BGPmon-core-1 > BGPmon::Fetch.pm

Download:
BGPmon-core-1-092.tar.gz

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source  

NAME ^

BGPmon::Fetch.pm

The BGPmon Fetch module, to connect to a live BGPmon stream, an online archive of XFB data, or a single XML file. The interface then supports "streaming" of XML messages from the given data source.

SYNOPSIS ^

The BGPmon::Fetch module provides functionality to connect to one of the following data sources: 1) a live BGPmon instance 2) an archive of XFB data 3) an individual XML file The user is then able to read XML messages in sequence from the appropriate data source and get information about the currently-running connection.

    use BGPmon::Fetch;
    my $ret = init_bgpdata();
    my $ret = connect_bgpdata();
    my $xml_msg = read_xml_message();
    if ( !defined($xml_msg) ){
        print get_error_code() . ": " . get_error_msg();
    }
    my $ret = is_connected();
    my $num_read = messages_read();
    my $uptime = uptime();
    my $ret = close_connection();
    my $downtime = connection_endtime();

EXPORT ^

init_bgpdata connect_bgpdata read_xml_message close_connection is_connected messages_read uptime connection_endtime get_error_code get_error_message get_error_msg

SUBROUTINES/METHODS ^

init_bgpdata

Initialize parameters for any/all of the Fetch submodules. File and Archive take the same three optional parameters:

    scratch_dir - a filesystem location to put a scratch directory in
        (default is /tmp)

    ignore_incomplete_data - a flag to turn off checking for possible gaps
        in the data "stream" (default is to check)

    ignore_data_errors - a flag to turn off checking for any other errors
        in the data. Using this flag requires setting ignore_incomplete_data.
        (default is to check)

Client also accepts the same scratch directory argument described above, but will ignore the data-integrity flags, as a live stream is, well, live.

Usage: my $ret = init_bgpdata('scratch_dir' => '/tmp', 'ignore_incomplete_data' => 1, 'ignore_data_errors' => 0); my $ret = init_bgpdata(); my $ret = init_bgpdata('scratch_dir' => "~/");

connect_bgpdata

This is a function which connects to the appropriate data source. If a live data source is specified, the function opens a TCP connection to the source. If an archived data source is specified, the function processes data files from the given URL. If a local file is specified, it will read data from the file.

Input: One of the following sets of arguments: [server_address, listening port] -> this will connect to live data [URL,start time, end time] -> this will connect to an archive [filename] -> this will connect to a file

Output: 1 on failure

read_xml_message

This function reads and returns the next XML message from the currently connected data source, or undef if there is an error OR there are no more messages available (in File or Archive).

Usage: my $msg = read_xml_message();

close_connection

This subroutine closes an active connection. For File and Archive, this will delete the scratch directory and close any open files. For a live stream, the TCP connection will be terminated. The function returns 0 on success, 1 on failure

Usage: close_connection();

is_connected

Subroutine that simply returns whether or not there is a currently-active connection. If no connection has been initialized, returns undef.

Usage: if( is_connected ) { #Do stuff }

messages_read

Returns the number of messages read from the data source. This also includes any additional metadata messages that may be in the stream or within files.

Usage: my $num_msgs = messages_read();

uptime

Returns number of seconds the connection has been up. If the connection is down or there has never been a connection, return 0.

Usage: my $up = uptime();

connection_endtime

Returns the time the connection ended. If the connection is up, return 0. If there has been no connection, returns -1.

Usage: my $e_time = connection_endtime();

get_error_code

Get the error code for a given function Input : the name of the function whose error code we should report Output: the function's error code or ARGUMENT_ERROR if the user did not supply a function or INVALID_FUNCTION_SPECIFIED if the user provided an invalid function Usage: my $err_code = get_error_code("connect_archive");

get_error_message

Get the error message of a given function Input : the name of the function whose error message we should report Output: the function's error message or ARGUMENT_ERROR if the user did not supply a function or INVALID_FUNCTION_SPECIFIED if the user provided an invalid function Usage: my $err_msg = get_error_message("read_xml_message");

get_error_msg

Shorthand call for get_error_message

ERROR CODES AND MESSAGES ^

The following error codes and messages are defined for the Fetch module. Additional error codes and messages are defined within Client, File, and Archive, and can be inspected by running perldoc on each of them.

File uses Error codes 300-399 Archive uses Error codes 400-499 Client uses Error codes 500-599

    0:      No Error
            'No Error. Life is good.'

    101:    Too many or too few arguments were passed to connect_bgpdata or
                get_error_[code/message/msg]
            'Invalid number of arguments'

    102:    There is no connection (via connect_bgpdata) to a data source.
            'Not connected to a data source'

    103:    An invalid function name was passed to get_error_[code/message/msg]
            'Invalid function name specified'

AUTHOR ^

Kaustubh Gadkari, <kaustubh at cs.colostate.edu>

BUGS ^

Please report any bugs or feature requests to bgpmon at netsec.colostate.edu, or through the web interface at http://bgpmon.netsec.colostate.edu.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc BGPmon::Fetch

LICENSE AND COPYRIGHT ^

Copyright (c) 2012 Colorado State University

    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use,
    copy, modify, merge, publish, distribute, sublicense, and/or
    sell copies of the Software, and to permit persons to whom
    the Software is furnished to do so, subject to the following
    conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
    OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
    HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
    OTHER DEALINGS IN THE SOFTWARE.\

    File: Fetch.pm

    Authors: Kaustubh Gadkari, Dan Massey, Cathie Olschanowsky, Jason Bartlett
    Date: May 21, 2012
syntax highlighting: