Rogue Wave Server
API Reference Guide
Product Documentation:

Rogue Wave Server
Documentation Home
Rogue Wave Server Documentation

Introduction

This online version of the Reference Manual documents Rogue Wave Server, a large-scale object engine combining business objects with real-time business event notification to implement multi-tier client/server applications. It can be consulted from any HTML browser. A table of contents and an index give you direct access to any class or method.

General Remarks

Only parts of the library that are of use to build a Rogue Wave Server application are documented. Thus, inheritance among classes is only partially represented, and certain member functions actually belonging to base classes are intentionally documented in derived classes. Moreover, the following features are not documented:
  • Public or protected member functions used internally by the application.
  • Final arguments in the signature of certain functions that are set to default values and that are used internally.
Functions referred to as user-defined are functions that, when specified for a given class, alter the behavior of class templates that take that class as their argument.

Libraries Organization

The following table shows what header files each library contains.
LibrariesHeader FilesComments
dynmvsvr ilserver/dynimpl.h
ilserver/dynobj.h
ilserver/dynmoditp.h
ilserver/dynmvsvr.h
ilserver/scriptmgr.h
Use this library on the server side when you want to use Rogue Wave Server dynamic modeling capabilities or Rogue Wave Views Script integration on the server side.
ilog This library contains core Rogue Wave Views classes and must be linked both on the server and on the component side.
ilxml This library contains core Rogue Wave Views XML classes (an XML parser and a basic DOM implementation). It must be linked both on the server side and on the component side.
mvcomp ilserver/except.h
ilserver/ilbwin.h
ilserver/ilthread.h
ilserver/logfile.h
ilserver/mvcomp.h
ilserver/mvendpt.h
ilserver/mvmsg.h
ilserver/mvproc.h
ilserver/mvvalue.h
ilserver/refcount.h
ilserver/rp.h
ilserver/rpshared.h
ilserver/rtmodelp.h
ilserver/rttypes.h
ilserver/sstring.h
ilserver/ttime.h
Use this library on the component side of your application. This library contains the component part of the Rogue Wave Server generic protocol (IlsMvComponent, IlsRepresentation, IlsRpObject). Do not link this library with the mvserver or server library in the same executable.
mvconpan ilmvpan/vwconpan.h Use this library on the component side of your application to use the predefined Connection Panel of Rogue Wave Server. You must have a valid Rogue Wave Views license.
mvserver ilserver/datetime.h
ilserver/mvarray.h
ilserver/mvcomp.h
ilserver/mvendpt.h
ilserver/mvmsg.h
ilserver/mvproc.h
ilserver/mvserver.h
ilserver/mvuser.h
ilserver/mvvalue.h
ilserver/mvview.h
ilserver/rp.h
ilserver/rpshared.h
ilserver/rtmodel.h
ilserver/rtmodelp.h
Use this library on the server side to work with Rogue Wave Server dynamic view services. This library also contains the component part of the Rogue Wave Server generic protocol (IlsMvComponent, IlsRepresentation, IlsRpObject). Do not link the mvserver and mvcomp libraries in the same executable.
mvsw ilmvsw/hrefgad.h
ilmvsw/interact.h
ilmvsw/memtable.h
ilmvsw/mvswcomp.h
ilmvsw/repres.h
ilmvsw/row.h
ilmvsw/svdataso.h
ilmvsw/svswutil.h
ilmvsw/table.h
ilmvsw/tablegad.h
ilmvsw/util.h
Use this library on the component side of your application if you plan to use the Rogue Wave Server/Rogue Wave Views predefined mapping. Also link the mvswjs library if you want to use Rogue Wave Views Script on the component side. You must have a valid Rogue Wave Views license to use this predefined mapping.
mvtcp ilsever/mvtcp/timer.h
tcpmvproc.h
tcpvmvproc.h
Use this library both on the server and on the component side of your application to use the TCP/IP port of the Rogue Wave Views Server communication protocol. On UNIX, also link the mvvwtcp library if your application uses Rogue Wave Views.
mvvwtcp Use this library instead of the library mvtcp when you use Rogue Wave Views on UNIX.
server derived.h
except.h
ilbwin.h
ilthread.h
logfile.h
model.h
refcount.h
sstring.h
timer.h
ttime.h
transac.h
viewed.h
Use this library on the server side to work with the modelization services and view services offered by Rogue Wave Server.

Classes tab

Contains these four listings:

  • Alphabetical Index: A concise alphabetical index of the classes in the API.
  • Annotated List: An annotated alphabetical list of the classes in the API.
  • Class Hierarchy: A hyperlink class hierarchy.
  • Class Members: A comprehensive index of class members and related functions in the API.

Inherited Members

The main class description page only documents members declared in the class. That is, it does not document inherited members inline. To see the list of all members, whether declared in the class or inherited from a base class, click the List of all members link near the top of the class description page.


© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.