global.h

/* Copyright (c) 2005-2016, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * This file is part of Collage <https://github.com/Eyescale/Collage>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef CO_GLOBAL_H
#define CO_GLOBAL_H

#include <co/api.h>
#include <co/types.h>
#include <string>

namespace co
{
class Global
{
public:
    CO_API static void setDefaultPort( const uint16_t port );

    CO_API static uint16_t getDefaultPort();

    CO_API static void setObjectBufferSize( const uint32_t size );

    CO_API static uint32_t getObjectBufferSize();

    CO_API static bool fromString( const std::string& data );

    CO_API static std::string toString();

    // Note: also update string array initialization in global.cpp
    enum IAttribute
    {
        IATTR_INSTANCE_CACHE_SIZE,   

        IATTR_NODE_SEND_QUEUE_SIZE,
        IATTR_NODE_SEND_QUEUE_AGE,   
        IATTR_RSP_ACK_TIMEOUT,       
        IATTR_RSP_ERROR_DOWNSCALE,   
        IATTR_RSP_ERROR_UPSCALE,     
        IATTR_RSP_ERROR_MAXSCALE,    
        IATTR_RSP_MIN_SENDRATE_SHIFT, 
        IATTR_RSP_NUM_BUFFERS,       
        IATTR_RSP_ACK_FREQUENCY,     
        IATTR_UDP_MTU,               
        IATTR_UDP_BUFFER_SIZE,       
        IATTR_TILE_QUEUE_MIN_SIZE,   
        IATTR_TILE_QUEUE_REFILL,     
        IATTR_RDMA_RING_BUFFER_SIZE_MB, 
        IATTR_RDMA_SEND_QUEUE_DEPTH, 
        IATTR_RDMA_RESOLVE_TIMEOUT_MS, 
        IATTR_ROBUSTNESS,            
        IATTR_TIMEOUT_DEFAULT,       
        IATTR_OBJECT_COMPRESSION,    
        IATTR_CMD_QUEUE_LIMIT,     
        IATTR_ALL
    };

    CO_API static void setIAttribute( const IAttribute attr,
                                      const int32_t value );

    CO_API static int32_t getIAttribute( const IAttribute attr );

    CO_API static uint32_t getTimeout();

    CO_API static uint32_t getKeepaliveTimeout();

    CO_API static size_t getCommandQueueLimit();
};
}

#endif // CO_GLOBAL_H