cmd/lms/Channel.h

	Channel.h revision 617e2443dfc17fe44fd44c0675d6aad2ffc9df42
/*******************************************************************************
 * Copyright (C) 2004-2008 Intel Corp. All rights reserved.
 *
 * 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 following disclaimer.
 *
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 *  - Neither the name of Intel Corp. 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 Intel Corp. OR THE 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.
 *******************************************************************************/

#ifndef _CHANNEL_H_
#define _CHANNEL_H_

#include "PortForwardRequest.h"

#ifdef _LINUX
#ifndef SOCKET
#define SOCKET int
#endif
#endif

class Channel
{
public:
    enum CHANNEL_STATUS {
        NOT_OPENED,
        OPEN,
        WAITING_CLOSE,
        CLOSED
    };

    static const unsigned int LMS_WINDOW_SIZE = 4095;

    Channel(PortForwardRequest *portForwardRequest, SOCKET socket) :
        _recipientChannel(0),
        _senderChannel((unsigned int)socket),
        _socket(socket),
        _txWindow(0),
        _rxWindow(LMS_WINDOW_SIZE),
        _status(NOT_OPENED),
        _portForwardRequest(portForwardRequest) {}

    unsigned int GetRecipientChannel() const { return _recipientChannel; }
    unsigned int GetSenderChannel() const { return _senderChannel; }
    bool SetRecipientChannel(unsigned int recipientChannel) { _recipientChannel = recipientChannel; return true; }
    unsigned int GetTxWindow() const { return _txWindow; }
    unsigned int GetRxWindow() const { return _rxWindow; }

    bool AddBytesTxWindow(const int bytesToAdd)
    {
        if (_txWindow + bytesToAdd < 0) {
            _txWindow = 0;
            return true;
        }
        _txWindow += bytesToAdd;
        return true;
    }

    bool AddBytesRxWindow(const int bytesToAdd)
    {
        if (_rxWindow + bytesToAdd < 0) {
            _rxWindow = 0;
            return true;
        }
        _rxWindow = (_rxWindow + bytesToAdd > LMS_WINDOW_SIZE) ?
            (LMS_WINDOW_SIZE) :
            (_rxWindow + bytesToAdd);
        return true;
    }

    SOCKET GetSocket() const { return _socket; }
    CHANNEL_STATUS GetStatus() const { return _status; }
    bool SetStatus(const CHANNEL_STATUS newStatus) { _status = newStatus; return true; }
    PortForwardRequest * GetPortForwardRequest() const { return _portForwardRequest; }


private:
    unsigned int _recipientChannel;
    const unsigned int _senderChannel;
    const SOCKET _socket;
    unsigned int _txWindow;
    unsigned int _rxWindow;
    CHANNEL_STATUS _status;
    PortForwardRequest *_portForwardRequest;
};

#endif