Fermilab


MINOS Offline Documentation
[home] [installing MINOS software] [supported platforms] [package links] [mailing list] [HyperNews] [FAQ] [computing help] [MINOS glossary] [archives]

HowTo: the MINOS rotorooter C interface



roto_open_connection


 *=========================================================================
 * roto_open_connection(const char* ipaddr, int port, int whoami)
 * 
 * Purpose:
 *    Establish a connection with rotorooter
 *
 * Arguments:
 *    host:    host machine for rotorooter
 *    port:    port # rotorooter is listening on
 *    whoami:  identifier (MINOS_DCP or MINOS_DCS from rc.h)
 *
 * Return Value:
 *    non-zero indicates there was an error
 *=========================================================================

roto_close_connection


 *=========================================================================
 * roto_close_connection()
 * 
 * Purpose:
 *    Close the connection with rotorooter
 *
 * Arguments:
 *    (none)
 *
 * Return Value:
 *    non-zero indicates there was an error
 *=========================================================================

roto_open_daqfile


 *=========================================================================
 * roto_open_daqfile(int detector, int run, int subrun);
 * 
 * Purpose:
 *    Open/close a file (for writing) on the rotorooter
 *
 * Arguments:
 *    detector:  detector id (kNear=0x01,kFar=0x02,kCalDet=0x04)
 *    run:       run #
 *    subrun:    subrun #
 *
 *    Note: these three arguments are used by the rotorooter
 *          to construct a file name in a standardized scheme.
 *
 * Return Value:
 *    non-zero indicates there was an error
 *=========================================================================

roto_close_daqfile


 *=========================================================================
 * roto_close_daqfile(int detector, int run, int subrun);
 * 
 * Purpose:
 *    Close a file (for writing) on the rotorooter
 *
 * Arguments:
 *    detector:  detector id (kNear=0x01,kFar=0x02,kCalDet=0x04)
 *    run:       run #
 *    subrun:    subrun #
 *
 * Return Value:
 *    non-zero indicates there was an error
 *=========================================================================

roto_open_dcsfile


 *=========================================================================
 * roto_open_dcsfile(int detector, int sec, int nsec); 
 * 
 * Purpose:
 *    Open a file (for writing) on the rotorooter
 *
 *    Note: this uses the arguments to set a global (retained)
 *          values of the file name parameters to ensure that
 *          the is never more than one DCS file open at any time           
 *
 * Arguments:
 *    fname:   the remote file name
 *
 * Return Value:
 *    non-zero indicates there was an error
 *=========================================================================

roto_close_dcsfile


 *=========================================================================
 * roto_close_dcsfile()
 * 
 * Purpose:
 *    Close a file (for writing) on the rotorooter
 *
 *    Note: this takes no arguments because there should never
 *          be more than one DCS file open at any time           
 *
 * Arguments:
 *    (none)
 *
 * Return Value:
 *    non-zero indicates there was an error
 *=========================================================================

roto_send_record


 *=========================================================================
 * roto_send_record(const void* buffer, int nbytes)
 * 
 * Purpose:
 *    Send a (record) buffer of data to the rotorooter
 *
 * Arguments:
 *    buffer:   the actual data (does not include byte count)
 *    nbytes:   the number of relevant bytes in the buffer
 *
 * Return Value:
 *    non-zero indicates there was an error
 *=========================================================================

roto_request_shutdown


 *=========================================================================
 * roto_request_shutdown(int priority)
 * 
 * Purpose:
 *    Request that the Rotorooter shutdown
 *
 * Arguments:
 *    priority:  0 = if no other connections are in effect
 *               1 = server other connections
 *
 * Return Value:
 *    non-zero indicates there was an error
 *=========================================================================



Last Modified: $Date: 2002/12/17 21:32:15 $
Contact: rhatcher@fnal.gov
Page viewed from http://www-numi.fnal.gov/offline_software/srt_public_context/WebDocs/howto_roto_cinterface.html
Fermilab
Security, Privacy, Legal Fermi National Accelerator Laboratory