TransporterCallback.hpp

/*
   Copyright (C) 2003, 2005, 2006, 2008 MySQL AB, 2008, 2009 Sun Microsystems, Inc.
    All rights reserved. Use is subject to license terms.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; version 2 of the License.

   This program 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 General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
*/

//**************************************************************************** 
// 
//  AUTHOR 
//      Åsa Fransson 
// 
//  NAME 
//      TransporterCallback 
// 
// 
//***************************************************************************/ 
#ifndef TRANSPORTER_CALLBACK_H 
#define TRANSPORTER_CALLBACK_H 
 
#include <kernel_types.h> 
#include "TransporterDefinitions.hpp" 
 
 
#define TE_DO_DISCONNECT 0x8000

enum TransporterError {
  TE_NO_ERROR = 0,
  TE_ERROR_CLOSING_SOCKET = 0x1,

  TE_ERROR_IN_SELECT_BEFORE_ACCEPT = 0x2,

  TE_INVALID_MESSAGE_LENGTH = 0x3 | TE_DO_DISCONNECT,

  TE_INVALID_CHECKSUM = 0x4 | TE_DO_DISCONNECT,

  TE_COULD_NOT_CREATE_SOCKET = 0x5,

  TE_COULD_NOT_BIND_SOCKET = 0x6,

  TE_LISTEN_FAILED = 0x7,

  TE_ACCEPT_RETURN_ERROR = 0x8

  ,TE_SHM_DISCONNECT = 0xb | TE_DO_DISCONNECT

  ,TE_SHM_IPC_STAT = 0xc | TE_DO_DISCONNECT

  ,TE_SHM_IPC_PERMANENT = 0x21

  ,TE_SHM_UNABLE_TO_CREATE_SEGMENT = 0xd

  ,TE_SHM_UNABLE_TO_ATTACH_SEGMENT = 0xe

  ,TE_SHM_UNABLE_TO_REMOVE_SEGMENT = 0xf

  ,TE_TOO_SMALL_SIGID = 0x10
  ,TE_TOO_LARGE_SIGID = 0x11
  ,TE_WAIT_STACK_FULL = 0x12 | TE_DO_DISCONNECT
  ,TE_RECEIVE_BUFFER_FULL = 0x13 | TE_DO_DISCONNECT

  ,TE_SIGNAL_LOST_SEND_BUFFER_FULL = 0x14 | TE_DO_DISCONNECT

  ,TE_SIGNAL_LOST = 0x15

  ,TE_SEND_BUFFER_FULL = 0x16

  ,TE_SCI_UNABLE_TO_CLOSE_CHANNEL = 0x22

  ,TE_SCI_LINK_ERROR = 0x0017

  ,TE_SCI_UNABLE_TO_START_SEQUENCE = 0x18 | TE_DO_DISCONNECT

  ,TE_SCI_UNABLE_TO_REMOVE_SEQUENCE = 0x19 | TE_DO_DISCONNECT

  ,TE_SCI_UNABLE_TO_CREATE_SEQUENCE = 0x1a | TE_DO_DISCONNECT

  ,TE_SCI_UNRECOVERABLE_DATA_TFX_ERROR = 0x1b | TE_DO_DISCONNECT

  ,TE_SCI_CANNOT_INIT_LOCALSEGMENT = 0x1c | TE_DO_DISCONNECT

  ,TE_SCI_CANNOT_MAP_REMOTESEGMENT = 0x1d | TE_DO_DISCONNECT

  ,TE_SCI_UNABLE_TO_UNMAP_SEGMENT = 0x1e | TE_DO_DISCONNECT

  ,TE_SCI_UNABLE_TO_REMOVE_SEGMENT = 0x1f  | TE_DO_DISCONNECT

  ,TE_SCI_UNABLE_TO_DISCONNECT_SEGMENT = 0x20 | TE_DO_DISCONNECT

  /* Used 0x21 */
  /* Used 0x22 */
};

class TransporterCallback {
public:
  virtual void deliver_signal(SignalHeader * const header,
                              Uint8 prio,
                              Uint32 * const signalData,
                              LinearSectionPtr ptr[3]) = 0;

  virtual int checkJobBuffer() = 0;

  virtual void reportSendLen(NodeId nodeId, Uint32 count, Uint64 bytes) = 0;

  virtual void reportReceiveLen(NodeId nodeId, Uint32 count, Uint64 bytes) = 0;

  virtual void reportConnect(NodeId nodeId) = 0;

  virtual void reportDisconnect(NodeId nodeId, Uint32 errNo) = 0;

  virtual void reportError(NodeId nodeId, TransporterError errorCode,
                           const char *info = 0) = 0;

  virtual void transporter_recv_from(NodeId node) = 0;


  virtual void lock_transporter(NodeId node) { }
  virtual void unlock_transporter(NodeId node) { }

  virtual Uint32 get_bytes_to_send_iovec(NodeId, struct iovec *dst, Uint32) = 0;

  virtual Uint32 bytes_sent(NodeId node, Uint32 bytes) = 0;

  virtual bool has_data_to_send(NodeId node) = 0;

  virtual void reset_send_buffer(NodeId node, bool should_be_empty=false) = 0;

  virtual ~TransporterCallback() { };
};


class TransporterSendBufferHandle {
public:
  virtual Uint32 *getWritePtr(NodeId node, Uint32 lenBytes, Uint32 prio,
                              Uint32 max_use) = 0;
  virtual Uint32 updateWritePtr(NodeId node, Uint32 lenBytes, Uint32 prio) = 0;

  virtual bool forceSend(NodeId node) = 0;

  virtual ~TransporterSendBufferHandle() { };
};

#endif