wskservm.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
// ObjectWindows
// Copyright (c) 1995, 1996 by Borland International, All Rights Reserved
//
/// \file
/// Winsock for OWL subsystem.
/// Based on work by Paul Pedriana, 70541.3223@compuserve.com
//----------------------------------------------------------------------------
 
#if !defined(OWL_WSKSERVM_H)
#define OWL_WSKSERVM_H
 
#include <owl/private/defs.h>
#if defined(BI_HAS_PRAGMA_ONCE)
# pragma once
#endif
 
#include <owl/defs.h>
#include <owl/window.h>
#include <winsock.h>
 
 
namespace owl {
 
#define WINSOCK_NOERROR (int)0
#define WINSOCK_ERROR   (int)SOCKET_ERROR
 
//
// Is supposedly in RFC 883.
//
#define N_MAX_SERVICE_NAME 128
#define MSG_SERVICE_NOTIFY ((UINT)(WM_USER+302))
 
class _OWLCLASS TServiceManager;
 
#include <owl/preclass.h>
 
//
/// \class TServiceWindow
// ~~~~~ ~~~~~~~~~~~~~~
/// TServiceWindow is a private class created by the TServiceManager to catch
/// notifications.
//
class _OWLCLASS TServiceWindow : public TWindow {
  public:
    TServiceWindow(TServiceManager* newServiceManagerParent);
 
  protected: // CQ add this?
    /// Object to pass notifications
    //
    TServiceManager* ServiceManagerParent;
 
    TResult DoNotification(TParam1, TParam2);
 
  DECLARE_RESPONSE_TABLE(TServiceWindow);
};
class _OWLCLASS TServiceWindow : public TWindow {…};
 
//
/// \class TServiceEntry
// ~~~~~ ~~~~~~~~~~~~~
/// Encapsulates information about a service.
//
class _OWLCLASS TServiceEntry : public servent {
  public:
    TServiceEntry();
};
class _OWLCLASS TServiceEntry : public servent {…};
 
//
/// \class TServiceManager
// ~~~~~ ~~~~~~~~~~~~~~~
/// The TServiceManager class (and its friend class TServiceWindow) encapsulate the
/// Winsock database functions getservbyname(), getservbyport(),
/// WSAAsyncGetServByName(), and WSAAsyncGetServByPort(). These blocking (get...)
/// and non-blocking (WSA...) functions return information about the service name,
/// port, and protocol when given only a service name or a port.
//
class _OWLCLASS TServiceManager {
  public:
    TServiceManager();
    virtual ~TServiceManager();
 
    int   GetLastError();
    int   GetLastServiceCompletion();
    int   GetService(TServiceEntry*& sEntry, uint16 nPort, const char* szProtocol = 0);
    int   GetService(TServiceEntry*& sEntry, const char* szName,
                     const char* szProtocol = 0);
    int   GetServicePort(char* szName, uint16& nPort, const char* szProtocol = 0);
    int   GetServiceName(uint16 nPort, char* szName, const char* szProtocol = 0);
    int   GetServiceAsync(HANDLE& hService, uint16 nPort, const char* szProtocol = 0);
    int   GetServiceAsync(HANDLE& hService, char* szName, const char* szProtocol = 0);
    int   GetServiceAsync(TWindow& wndNotify, HANDLE& hService, uint16 nPort,
                          const char* szProtocol = 0, uint nMessage = MSG_SERVICE_NOTIFY,
                          char* chBuffer = 0);
    int   GetServiceAsync(TWindow& wndNotify, HANDLE& hService, char* szName,
                          const char* szProtocol = 0, uint nMessage = MSG_SERVICE_NOTIFY,
                          char* chBuffer = 0);
    int   CancelServiceRequest(HANDLE hService = 0);
    bool  GetServiceRequestCompleted();
 
  public_data:
    /// Set to point to chServiceBuffer.
    //
    TServiceEntry* ServiceEntry;
 
  protected:
    int            LastError;                       ///< Last error code
    int            OutstandingServiceRequests;      ///< Count of total requests done by myself that haven't completed yet.
    bool           LastServiceRequestCompleted;     ///< Is the last request done?
    char           ServiceBuffer[MAXGETHOSTSTRUCT]; ///< Used for calls to WSAAsync...()
    HANDLE         LastServiceRequest;              ///< Handle of last service request
    TServiceWindow Window;                          ///< Private window for catching notification
 
    void ServiceCompleted(int nError);
 
  friend class TServiceWindow;
};
class _OWLCLASS TServiceManager {…};
 
#include <owl/posclass.h>
 
 
//----------------------------------------------------------------------------
// Inline implementations
//
 
//
/// This function returns the last error code.
//
inline int
TServiceManager::GetLastError()
{
  return LastError;
}
TServiceManager::GetLastError() {…}
 
//
/// This function returns the last service completion.
/// \todo why int return type?
//
inline int
TServiceManager::GetLastServiceCompletion()
{
  return LastServiceRequestCompleted;
}
TServiceManager::GetLastServiceCompletion() {…}
 
//
/// This function returns true if the last service requested has been completed.
//
inline bool
TServiceManager::GetServiceRequestCompleted()
{
  return LastServiceRequestCompleted;
}
TServiceManager::GetServiceRequestCompleted() {…}
 
} // OWL namespace
 
 
#endif  // OWL_WSKSERVM_H