/*****************************************************************************
*
* Copyright (c) 2000 - 2013, Lawrence Livermore National Security, LLC
* Produced at the Lawrence Livermore National Laboratory
* LLNL-CODE-442911
* All rights reserved.
*
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution  and  use  in  source  and  binary  forms,  with  or  without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of  source code must  retain the above  copyright notice,
*    this list of conditions and the disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL nor the names of  its contributors may
*    be used to endorse or promote products derived from this software without
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
* ARE  DISCLAIMED. IN  NO EVENT  SHALL LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  OR  CONTRIBUTORS BE  LIABLE  FOR  ANY
* DIRECT,  INDIRECT,   INCIDENTAL,   SPECIAL,   EXEMPLARY,  OR   CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT  LIMITED TO, PROCUREMENT OF  SUBSTITUTE GOODS OR
* SERVICES; LOSS OF  USE, DATA, OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER
* CAUSED  AND  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT
* LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY  WAY
* OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/

#include <KeepAliveRPC.h>
#include <DebugStream.h>

// ****************************************************************************
// Method: KeepAliveRPC::KeepAliveRPC
//
// Purpose: 
//   Constructor.
//
// Programmer: Brad Whitlock
// Creation:   Fri Mar 12 10:05:46 PDT 2004
//
// Modifications:
//   
// ****************************************************************************

KeepAliveRPC::KeepAliveRPC() : BlockingRPC("i", NULL)
{
    value = 0;
}

// ****************************************************************************
// Method: KeepAliveRPC::~KeepAliveRPC
//
// Purpose: 
//   Destructor.
//
// Programmer: Brad Whitlock
// Creation:   Fri Mar 12 10:05:57 PDT 2004
//
// Modifications:
//   
// ****************************************************************************

KeepAliveRPC::~KeepAliveRPC()
{
}

// ****************************************************************************
// Method: KeepAliveRPC::operator()
//
// Purpose: 
//   Invocation method for the RPC.
//
// Arguments:
//   v : The value to pass along.
//
// Programmer: Brad Whitlock
// Creation:   Fri Mar 12 10:06:15 PDT 2004
//
// Modifications:
//   
// ****************************************************************************

void
KeepAliveRPC::operator()()
{
    SetValue(value + 1);
    debug3 << "Executing keep alive RPC"
           << "\n\t value='" << value << "'"
           << endl;
    Execute();
}

// ****************************************************************************
// Method: KeepAliveRPC::SelectAll
//
// Purpose: 
//   Selects the value that we received.
//
// Arguments:
//
// Returns:    
//
// Note:       
//
// Programmer: Brad Whitlock
// Creation:   Fri Mar 12 10:07:30 PDT 2004
//
// Modifications:
//   
// ****************************************************************************

void
KeepAliveRPC::SelectAll()
{
    Select(0, (void*)&value);
}

// ****************************************************************************
// Method: KeepAliveRPC::SetValue
//
// Purpose: 
//   Sets the RPC's value.
//
// Arguments:
//   v : The new value for the RPC's value field.
//
// Programmer: Brad Whitlock
// Creation:   Fri Mar 12 10:08:19 PDT 2004
//
// Modifications:
//   
// ****************************************************************************

void
KeepAliveRPC::SetValue(int v)
{
    value = v;
    SelectAll();
}

// ****************************************************************************
// Method: KeepAliveRPC::GetValue
//
// Purpose: 
//   Returns the value for the RPC's value field.
//
// Returns:    The RPC's value field.
//
// Programmer: Brad Whitlock
// Creation:   Fri Mar 12 10:09:02 PDT 2004
//
// Modifications:
//   
// ****************************************************************************

int
KeepAliveRPC::GetValue() const
{
    return value;
}

// ****************************************************************************
// Method: KeepAliveRPC::TypeName
//
// Purpose: 
//   Returns the RPC name.
//
// Programmer: Brad Whitlock
// Creation:   Fri Dec  7 11:09:23 PST 2007
//
// Modifications:
//   
// ****************************************************************************

const std::string
KeepAliveRPC::TypeName() const
{
    return "KeepAliveRPC";
}
