# Patent

## Title
Network object request broker to automatically connect client and server objects in a distributed environment

## Abstract

A method and system that can efficiently broken objects in a real-time constrained network. The method and system provide two main types of interfaces: client object and server object interfaces. Each client object and server object is instantiated from a class derived from a base class. The class libraries may be written in any object-oriented programming language and compiled on to any platform. Thus, the methodology and system are easily ported to other platforms. Additionally, mirrored client and server objects may be generated which allow an object to behave both as a client and as a server.

## Background
RELATED APPLICATIONS
This is a divisional of U.S. patent application Ser. No. 08/937,093, now U.S. Pat. No. 6,275,870, filed on Sep. 24, 1997.


COMPUTER PROGRAM LISTING APPENDIX
A computer program listing appendix (50L1868 01 code.cc), submitted on duplicate compact discs, includes Appendix A as referred to herein. The computer program listing appendix is hereby incorporated by reference.
BACKGROUND OF THE INVENTION
1. Field of the Invention
The invention relates generally to the field of computer software. More specifically, the invention relates to object-oriented programming structures.
2. Background
When two or more information devices such as computing machines or audio/video (A/V) equipment are connected together in a network environment, the method and means of communication amongst them should be robust and tailored to fit the application being performed. One such method and means known as COM (Component Object Model) developed by Microsoft Corporation, provides for a highly developed system of “objects” transacted among software components executing within a single device such as a personal computer. Since COM does not adequately support the passing of such objects among components executing on separate devices, an extension of COM known as DCOM (Distributed Component Object Model) was also developed. One operating system platform that adopts and transacts objects according to DCOM is the Windows NTTM operating system (a trademark of Microsoft Corporation).
While useful for many computing applications deriving from or desiring the use of a network, DCOM is inadequate for certain other applications. One class of applications for which DCOM is inadequate and prohibitive, are real-time applications. Real-time applications suffer greatly under the effect of high latency due to the tremendous overhead involved in DCOM. For instance, DCOM, at every instantiation or a new object requires that a class factory first be instantiated and that then the object be manufactured.
Further, under DCOM, the creation of every object involves a search through the windows operating system “registry” which tracks objects for all the various applications and services running under the operating system. While DCOM is highly extensible making for easy creation or new objects dynamically, by linking, for example, to a Dynamic Linked Library, this introduces more overhead and latency. In a real-time system where the system components and their objects are fairly well-known and defined, there is no motivation for such extensibility.
A further problem with DCOM technology and other such operating system specific object-oriented technology is one of non-portability. A non-Windows NTTM or Windows 95 computer system cannot run applications that utilize DCOM. Thus, applications written with object-oriented methods of DCOM cannot be ported to other platforms without great difficulty.
What is needed is a simpler, more efficient and lower latency distributed object technology that enables multiple devices on a network to interact. Further, it would be desirable for such a technology to be easily ported from one platform to the next, such that utilizing applications can also be readily ported.
SUMMARY OF THE INVENTION
What is disclosed is a method for efficiently connecting client objects and server objects in a distributed environment. The method includes he initiating a server object interface and a client object interface. The creation of the client object interface forms an automatic connection between client object and server object. For those objects desired act as both client and server, mirrored interfaces are also initiated.



BRIEF DESCRIPTION OF THE DRAWINGS
The objects, features and advantages of the method and apparatus for the present invention will be apparent from the following description in which:
FIG. 1 is a flow diagram illustrating the connecting of network objects.
FIG. 2(a) illustrates the nheritance hierarchy for servers and server objects.
FIG. 2(b) illustrates the inheritance hierarchy for clients and client objects.
FIG. 3 illustrates an exemplary real-time system employing the various embodiments of the invention.
FIG. 4 illustrates a computer system capable of implementing the various embodiments of the invention.



DETAILED DESCRIPTION OF THE INVENTION
Referring to the figures, exemplary embodiments of the invention will now be described. The exemplary embodiments are provided to illustrate aspects of the invention and should not be construed as limiting the scope of the invention. The exemplary embodiments are primarily described with reference to block diagrams or flowcharts. As to the flowcharts, each block within the flowcharts represents both a method step and an apparatus element for performing the method step. Depending upon the implementation, the corresponding apparatus element may be configured in hardware, software, firmware or combinations thereof.
FIG. 1 is a flow diagram illustrating the connecting of network objects.
Objects which originate from external nodes of a network or reside at a local node may at times behave like a “server”. A server object may be a data set, function call or state maintainer that provides or offers services when requested. The requester may also be itself an object and when requesting acts as a “client” object. FIG. 1 illustrates a methodology for connecting together the client object and server object which is efficient and permits real-time system operation.
First, to create a server object, an object is instantiated from a class derived from a base server class (referred to as SyIfServerBase) (step 110). This base server class allows multiple server objects to be created and is included in the run-time environment of ail network nodes. Next, to make the newly instantiated server object visible to other network objects, an interface to the newly instantiated server object is exposed to the system/network (step 120). To expose an interface, several function calls are initiated. Appendix A shows two such calls ProvideInterface and ExportInterface. These function calls make other lower-level operating system calls which expose the interface for object to connect to them.
Next, when the interface to server object is exposed, it passes along to any clients a unique server ID (referred to as RPCServerID). This ID is unique because for each server object that is created, the RPC Server ID is incremented by 1. Thus, for each subsequent object, its ID will be unique with respect to other ID's in the system process. Having a unique RPCServerID guarantees that server object will be exclusively identified when communicating with client objects.
Once the ID of a server object has been established and exposed along with the interface, then the client connection can be initiated. In order for the object to attain the status of a client, it is instantiated from a class that has been derived from a base client class (referred to as SyIFaceBase in Appendix A) (step 140). This base client class allows any number of clients to descend with characteristics consistent with that of a “client” object. The creation of client object “automatically” connects the client object with the server interface (step 150). Before any client objects can be created, a server object must have its interface exposed to the network/system. During creation of a client object, the RPCServerID is passed to it through an interface other than the interface to the server object. An RPCServerID is only required for those server objects having more than one instance (examples are described below). Thus, client objects can connect to server object interfaces without the RPCServerID in those cases here the RPCServerID is not needed to identify the server object interface.
For any given server object, especially in a distributed environment, it would be desirable to allow multiple client objects to connect to one server object. This is enabled by repeating steps 140–150 for each such client object. New server objects may be instantiated at any time regardless of whether all corresponding client objects have been created or not.
If there are any server objects that need to be created (checked at step 160), a new server object is instantiated from a class that is derived from the same base server class which instantiated the previous server object(s) (step 110). Thus, steps 110–150 repeat for every new server object. Objects can be disconnected by reversing the above methodology. Interfaces can be removed and garbage collection performed to disconnect objects. Further, objects may be disposed of if they are not being utilized by the system.
The methodology of FIG. 1 is efficient by connecting client objects automatically to their respective server object. In a real-time system, this reduction latency offered by such a mechanism is valuable. By contrast, as mentioned in the background, DCOM introduces many extra features not needed in a well-defined real-time system, and thus adds excess overhead, such as the creation of class factories or the querying of a registry to obtain information regarding objects.
FIG. 2(a) illustrates the inheritance hierarchy for servers and server objects.
The class inheritance hierarchy for server objects has as a root, the base server class SyIfServerBase (see Appendix A). Server Interface 1, an interface for a first server object, descends from base server class SyIfServerBase. Likewise the Server Interface 2, an interface for a second server object descends from the same base server class SyIfServerBase. Thus, the construction of a single base class allows for efficient and rapid creation of new server object interfaces.
FIG. 2(a) introduces another type of interface, the Mirrored Server Interface. When an object wishes to act as both a client and server (i.e., both requesting and providing data, calls, etc.), then a Mirrored Interface is created. Since the server class requires communication both to and from the client, it is appropriate to derive or descend the base mirror class (SyIfServerMirror) from the base server class SyIfServerBase. For objects that desire to behave both as clients and as servers, interfaces such as Mirrored Server Interface 1 and Mirrored Server Interface 2 are created and exposed to the network or object environment. FIG. 2(a) shows a Mirrored Server Interface 1 and Mirrored Server Interface 2 that are descended from the base Mirrored Server class. Objects attached to the Mirror Server Interface act as server objects, but as illustrated in FIG. 2(b) may also take on the characteristic of a client object. The Mirrored Server Interface establishes a two-way one-to-one connection between a server object acting as a client and a client object acting as a server. The mirrored server exposes an interface which the client, and only that one client, connect to. The client object also exposes an interface for the server object to connect to.
FIG. 2(b) illustrates the inheritance hierarchy for clients and client objects.
The class inheritance hierarchy for client objects has as a root, the base client class SyIFaceBase (see Appendix A). Client Interface 1, an interface for a first client object, descends from base client class SyIFaceBase. Likewise the Client Interface 2, an interface for a second client object descends from the same base client class SyIFaceBase. Thus, the construction of a single base class allows for efficient and rapid creation of new client object interfaces.
FIG. 2(b) introduces another type of interface, the Mirrored Client Interface. When an object wishes to act as both a client and server (i.e., both requesting and providing data, calls, etc.), then a pair of Mirrored Interfaces are created. FIG. 2(a) above showed the creation of a mirrored server interface. Since the client class requires communication both to and from the server, it is appropriate to derive or descend the base mirror class (SyIFaceMirror) from the base client class SyIFaceBase. For objects that desire to behave both as clients and as servers, interfaces such as Mirrored Client Interface 1 and Mirrored Client Interface 2 are created and exposed to the network or object environment. FIG. 2(b) shows a Mirrored Client Interface 1 and Mirrored Client Interface 2 that are descended from the base Mirrored Client class. The Mirrored Client Interface establishes a two-way one-to-one connection between a client object acting as a server and server object acting as a client. The mirrored client exposes an interface which a mirrored server, through its Mirrored Server Interface, can connect to.
One advantage not readily apparent in the illustrations of FIGS. 2(a)–2(b) is ease of implementation and portability as compared with DCOM. The code shown in Appendix A can be generalized for any operating environment and the hierarchy in FIGS. 2(a)–2(b) may be implemented in C++. This differs from DCOM, which specifies its own object terminology and could only be implemented in a Windows environment or other operating system that Microsoft chooses to support. The invention, in its various embodiments, can, by contrast, be implemented in any object oriented programming language such as C++ or Java, and thus enjoys great portability. By changing merely the terminology of certain operating system specific calls, the C++ code or class modules can be recompiled when it is desired to port the invention to other platforms such as UNIX or any real-time operating system that is required. The class hierarchy of FIGS. 2(a)–2(b) may be thus identically employed in any platform. Though the code shown in Appendix A in NT-call specific, one of ordinary skill can readily implement the various embodiments of the invention by modifying the NT specifics to other platform specific calls.
FIG. 3 illustrates an exemplary real-time system employing the various embodiments of the invention.
The components of the FIG. 3 system are distributed over a network 305 which is a form of communications interface that links together remotely located devices by wire and/or propagated wave. The real-time system of FIG. 3 has a plurality of audio/video (A/V) processors 340, 350, 360 and 380 which are controlled Remote Control Centers (RCCs) 320 and 330. RCC 320 controls A/V processor 340 and A/V processor 350 while RCC 330 controls A/V processor 360 and A/V processor 380. RMS 310 serves to maintain state information and timing information for synchronizing the network devices and serves to monitor RCC 320 and RCC 330.
Using the object-oriented approach shown in the various embodiments of the invention, the real-time system of FIG. 3 can operate as follows. When any of the networked devices has powered up, that device can begin to execute, independent of other devices, the class methodology shown in FIG. 2. Thus, each device, in this exemplary embodiment, has its own executable code which when including the class definitions of the inventions will be capable of brokering its own objects to other devices.
Upon system start-up, each A/V processor and each RCC looks for the RMS 310 to have started or initialized. When RMS 310 has started, each A/V processor and/or RCC will register itself. This is achieved by the RMS exposing an interface (see iAlloc of Appendix A) as a server object. This interface descends from the base server class. Once the RMS has initialized, each device will register itself by calling the interface to RMS 310. The interface to RMS 310 will provide a binding handle to each of the client (or objects), the RCCs and A/V processors.
Next, each RCC 320 and 330 will call the RMS interface again to inform the RMS which A/V processor(s) it controls and has responsibility for managing. By repeatedly utilizing the single RMS server interface, the RMS can be made aware of the topology and scheduling of all components on the network. The RCCs and A/V processors are “client” objects in relation to the RMS since they connect to the RMS as clients to the iAlloc interface with a binding handle since iAlloc is only instantiated once in the system. In one regard, the binding handle can be viewed as a client ID which identifies which client is connecting with the server.
Though each RCC controls its respective A/V processors, each A/V processor is capable of self-control/manipulation as well. For instance, if A/V processor 380 were outfit with a control panel that a user could manipulate to change certain settings, then, unless a “mirrored” interface were provided, RCC 330 which is responsible for A/V processor 380 would be unaware of the setting changes. Further, the RMS 310 would be unaware of the change in settings and thus, could not issue control information, if needed, to other A/V processors.
Each A/V processor of the real-time system in FIG. 3 is capable of independent data processing. In this example, no audio/video data which is processed on an A/V processor originates from other A/V processors on the network (see FIG. 4), and thus, network 305 is not responsible for passing audio/video data across the network. Though A/V processors 340, 350, 360 and 380 process locally originating data, the processing involves synchronization of the separate streams to begin and end at a particular time index. For instance, each A/V processor may be responsible for processing a certain number of audio streams (channels) that are to later to be combined or mixed. In this case, the A/V processor must synchronize their operation to at least correctly insert timing information.
In the embodiment shown, for example, each A/V processor will have the following interfaces: iEBX (information for the entire A/V processor such as IDs, etc.), iVolume (information identifying the mass storage device used by the A/V processor), and iChannel (information regarding the audio stream). If A/V processor 340 is processing four channels of audio data, for example, then iChannel would be instantiated four times. Since iChannel is indicative of changes that can be initiated by both an RCC and by the A/V processor itself, it is desirable to provide a mirrored server interface for each iChannel.
Each A/V processor has an iEBX, which since it is a client only to the corresponding RMS, It will be identified by a binding handle rather than a unique ID. With each “process” or “machine” such as an A/V processor, any other objects with more than one instance, such as iChannel and iVolume will have RPCServerIDs identifying them. For instance, a client object connects to an A/V processor first through iEBX using a binding handle. Thereafter, the client object can communicate with an iVolume (using a RPCServerID if more than one iVolume is on the device, such as shown on A/V processor 380) to get the RPCServerIDs for the iChannel interfaces. Then the client object will be able to access and identify correctly the audio channel about which information is being passed.
The mirrored server interface (see FIG. 2) for iChannel will allow information about each channel, such as whether the channel has been muted, to be passed in two-way communication with a mirrored client. This two-way mirrored interface would allow a channel to be muted via a control local to the A/V processor while also informing the interested network components such as the controlling RCC and RMS, that the channel has been muted. The object implementing the muting of that channel is the mirrored server, and a mirrored client would be notified of the change in state when it occurs by using the mirrored client interface.
Since no audio/video data is being transferred over the network, any latency is due only to the passing of control/state/administrative information between components. The object-interface model provided for by the various embodiments of the invention reduces the latency from the prior art DCOM/COM model because of the reduced overhead/latency in instantiating and connecting objects over the network. In the system of FIG. 3, objects created using the COM or DCOM technology would disrupt the real-time performance of the system which needs objects such as state information whether a channel has been muted or is recording to be passed quickly is too prohibitive.
For instance, if a change in state, such as the recording of a channel is occurring on one A/V processors without consent of the RCC, then, to inform the RCC of the change in state, the RCC would need to become a client. If a mirrored client interface on the RCC and a Mirrored Server Interface for iChannel is already present, then state change will pass quickly from interface to interface and thus from object to object. The establishing of an interface allows objects to quickly share information. By contrast, DCOM introduces more parameters and and other external interfacing making the function calls to support objects have more overhead. This introduces latency and while, DCOM is more dynamic, such robustness is not needed in a close-ended system such as that shown in FIG. 3.
Thus, depending upon the application involved, the interfaces will need to pass only information that objects request or need and since the system for which the class code is written does not vary dramatically from run-time to run-time, unlike DCOM, which deals with more arbitrary conditions, the interfacing operation is more streamlined. One of ordinary skill in the art will be able readily to tailor the server-client-mirrored interface class of the various embodiments of the invention to that of the particular system apparatus and method on application by slightly modifying the code shown in Appendix A. Additionally, though FIG. 3 refers to physical components of a network, the concept is extendible to processes which may operate similar to the described components.
FIG. 4 illustrates a computer system capable of implementing the various embodiments of the invention.
Each of the A/V processors shown in FIG. 3 can be implemented as a computer system shown in FIG. 4. The computer system of FIG. 4 includes a CPU (Central Processing Unit) 420, memory 410, DSP (Digital Signal Processing) unit 440, output device 450 and a network interface (NI) 430.
A bus 405, such as PCI (Peripheral Component Interconnect), couples together CPU 420, memory 410, DSP unit 440, output device 450 and NI 430 such that they may transact data and control information among one another. The C++ class libraries mentioned in the various embodiments of the invention which includes the base server class, base client class, base mirrored client class and base mirrored server class can be compiled as a set of instructions stored in memory 410 and executed by CPU 420. Other instructions, such as the command to record audio data onto a storage unit 470, may also be loaded into memory 410 for execution by CPU 420. These class libraries may be stored on storage unit 70 prior to being compiled and executed. When audio/video data is played/recorded, the channels of data are processed by DSP unit 440 which may be a single interface card or a combination of hardware (Integrated Circuit) and software. The processed data is then rendered or “played” on output device 450 such as speaker or display.
Commands to play, record, mute a channel and so on may originate from a network 400 with whom communication is made possible by NI 430. According to one embodiment of the invention, the client object interface and mirrored interfaces can connect to a server object interface (such as iRCC, see FIG. 3) which is exposed on network 400. If a local control panel 460 were used to change the processing by, for example, the muting of a channel, then a Mirrored Server Interface would be utilized to notify other objects (which then act as clients requesting information) on network 400 that the channel has been muted. If the iChannel interface for that channel is already created, then a mirrored server interface, whether already existing or newly created, will allow such notification to take place. These interfaces may be created during run-time when CPU 420 is executing the code which operates the system.
The exemplary embodiments described herein are provided merely to illustrate the principles of the invention and should not be construed as limiting the scope of the invention. Rather, the principles of the invention may be applied to a wide range of systems to achieve the advantages described herein and to achieve other advantages or to satisfy other objectives as well.

## Claims

1. A method for connecting objects over a network of nodes comprising:
exposing an interface on a server object for a server node; and
instantiating a client object for a client node, said instantiating automatically connecting said client object to said interface on said server object, said client object being operable for initiating a request for a service provided by said server object, said client and server objects derived from different base object classes having different functions; and
exposing a mirrored client interface on the client object, wherein said client object acts as a server for an object connected to said mirrored client interface.

2. The method according to claim 1 further comprising:
deriving said server object from a base server class; and
assigning a unique server ID to said server object.

3. The method according to claim 1 further comprising:
deriving said client object from a base client class.

4. The method according to claim 2 further comprising:
deriving a new server object from said base server class;
exposing an interface on said new server object; and
assigning a unique server ID to said new server object.

5. The method according to claim 1 further comprising:
exposing an mirrored server interface on said server object, wherein said server object acts as a client of an object connected to said mirrored server interface; and
connecting said client object to said mirrored server interface on said server object.

6. The method according to claim 1 further comprising:
instantiating a new client object for each one of a plurality of clients that is to use said service provided by said server object.

7. The method according to claim 1, wherein said server object is one of a plurality of server objects providing services and further comprising:
instantiating a new client object for each one of a plurality of clients that is to use said services provided by said plurality of server objects.

8. A system for, connecting two objects over a network of nodes comprising:
a server object interface exposed on a first server object on a server node and configured to pass a unique server ID; and
a client object interface exposed on said first server object and configured to connect a plurality of client objects on at least one client node with said first server object, each of said plurality of client objects being operable for initiating a request for a service provided by said first server object, said first server and client objects derived from different base object classes having different functions.

9. The system according to claim 8 further comprising:
a mirrored client object interface exposed on a second server object and configured to pass a unique server ID, wherein said second server object acts as a client of said first server object when said first server object is connected to the mirrored client object interface; and
a mirrored server object interface exposed on said first server object and configured to connect a single client object with said first server object, said first server object being operable for initiating a request for a service provided by said single client object.

10. The system according to claim 9 wherein said interfaces are instantiated from a class library.

11. The system according to claim 8 further comprising a network interface for exposing said interfaces and for communicating said unique server ID within said network.

12. A data processing system for connecting objects over a network of nodes comprising:
a central processing unit (CPU) configured to execute instructions and process data; and
a memory coupled to said CPU, said memory placing instructions to cause said CPU to execute a method comprising:
exposing an interface on a server object on a server node;
instantiating a client object on a client node, said instantiating automatically connecting said client object to said interface on said server object, said client object being operable for initiating a request for a service provided by said server object, said server and client objects derived from different base object classes having different functions; and
exposing a mirrored client interface on the client object, wherein said client object acts as a server for an object connected to said mirrored client interface.

13. The data processing system according to claim 12 further comprising a storage unit configured to store said instructions and make them available to said memory.

14. The data processing system according to claim 12 wherein causing the memory to place instructions to said CPU causes said CPU to further execute said method comprising:
exposing a mirrored server interface on said server object, wherein said server objects acts as a client of an object connected to said mirrored server interface; and
connecting said client object to said mirrored server interface on said server object.

15. The data processing system according to claim 12 further comprising a network interface, said network interface permitting said server object interface to be exposed onto said network, said network further exposing client objects and their interfaces from an additional data processing system.

16. The data processing system according to claim 12 further comprising a control panel operable for modifying a data processing parameter.