Method and system for network marshalling of interface pointers for remote procedure calls

• US 5,511,197 A
• Filed: 11/29/1993
• Issued: 04/23/1996
• Est. Priority Date: 11/13/1992
• Status: Expired due to Term

• Current Assignee: Microsoft Technology Licensing LLC (Microsoft Corporation)
• Original Assignee: Microsoft Corporation
• Inventors: Hill, Richard D., Williams, Antony S., Atkinson, Robert G., Chan, Shannon J., Wittenberg, Craig H., Leach, Paul, Jung, Edward K., Mitchell, Alexander A., Corbett, Tom
• Primary Examiner(s): Kriess, Kevin A.
• Application Number:
  US08/158,627
• Time in Patent Office: 876 Days
• Field of Search: 395/700, 395/650
• US Class Current: 719/328
• CPC Class Codes: G06F 9/4488 Object-oriented
• CPC Class Codes: G06F 9/547 Remote procedure calls [RPC]; Web services
• CPC Class Codes: G06F 9/548 Object oriented; Remote method invocation [RMI] non-remote method invocation G06F9/449

Abstract

A computer method and system for passing a pointer to an interface from a server process to a client process. In a preferred embodiment, the server process instantiates an object that has multiple interfaces. The server process identifies an interface to pass to the client process and creates a stub object for receiving a request to invoke a function member of the interface and for invoking the requested function member upon receiving the request. The server process then sends an identifier of the stub to the client process. When the client process receives the identifier of the stub, it instantiates a proxy object for receiving requests to invoke a function member of the interface and for sending the request to the identified stub. The client process can then invoke the function members of the interface by invoking function members of the proxy object. The proxy object sends a request to the identified stub. The identified stub then invokes the corresponding function member of the interface.

Claims

1. A method in a computer system network for passing a pointer to an interface of an object from a server process in one node of the network to a client process in another node of the network to enable the client process to invoke function members of the interface, the method comprising the steps of:

within the server process,

instantiating the object, the object having an implementation of the interface, the interface having a function member;

creating an interface stub for receiving a request to invoke the function member of the interface and for invoking the requested function member upon receiving the request;

creating a stub channel for receiving the request to invoke the function member of the interface and for forwarding the request to the created interface stub; and

sending an identifier of the stub channel to the client process via network communications; and

within the client process,

receiving the identifier of the stub channel from the server process;

creating an interface proxy for receiving the request to invoke a function member of the interface and for sending the request to a proxy channel;

obtaining a pointer to the created interface proxy; and

creating the proxy channel for receiving the request from the created interface proxy and sending the request to the stub channel identified by the received identifier,

whereby the client process may use the pointer to the interface proxy to invoke the function member of the interface of the object instantiated within the server process.

2. The method of claim 1 including the steps of:

within the server process,

sending an unmarshal class identifier to the client process identifying the class of the interface proxy; and

within the client process,

receiving the unmarshal class identifier from the server process; and

dynamically loading code to instantiate an object of the class identified by the unmarshal class identifier wherein the step of creating the interface proxy executes the dynamically-loaded code.

3. The method of claim 2 including the step of:

within the client process,

retrieving from a persistent registry an indicator identifying code for instantiating an object of the class identified by the received unmarshal class identifier,

and wherein the dynamically loading step dynamically loads the code identified by the retrieved indicator.

4. The method of claim 1 including the steps of:

within the server process,

sending an indicator of the class of the proxy channel to the client process; and

within the client process,

receiving the indicator of the class of proxy channel,

and wherein the step of creating a proxy channel includes the step of instantiating an object of the class indicated by the received indicator.

5. The method of claim 1 wherein the proxy and stub channels are adapted to receiving requests to invoke a function member of any interface.

6. The method of claim 1 including the step of within the server process, sending a plurality of binding protocols to the client process wherein the client process selects one of the plurality of binding protocols to communicate with the server process.

7. A method in a computer system for passing a pointer to an interface of an object from a server process to a client process to enable the client process to invoke function members of the interface, the method comprising the steps of:

within the server process,

instantiating the object, the object having a plurality of interfaces, each interface having a function member;

identifying an interface of the object to pass to the client process;

creating a stub for receiving a request to invoke the function member of the identified interface and for invoking the function member upon receiving the request, the stub having an identifier; and

sending the identifier of the stub to the client process; and

within the client process,

receiving the identifier of the stub from the server process;

instantiating a proxy object for receiving requests to invoke a function member of the interface and for sending the request to the identified stub; and

obtaining a pointer to the instantiated proxy object,

whereby the client process may use the pointer to the interface proxy to invoke the function member of the interface of the object instantiated within the server process.

8. The method of claim 7 including the steps of:

within the server process,

sending an unmarshal class identifier identifying the class of the proxy object to instantiate in the step of instantiating a proxy object to the client process; and

within the client process,

receiving the unmarshal class identifier from the server process; and

accessing code to instantiate an object of the class identified by the unmarshal class identifier wherein the step of instantiating a proxy object executes the accessed code.

9. The method of claim 8 wherein the accessing step includes the step of selecting earlier loaded code capable of instantiating an object of the class identified by the unmarshal class identifier.

10. The method of claim 8 wherein the accessing step includes the step of dynamically loading code capable of instantiating an object of the class identified by the unmarshal class identifier.

11. The method of claim 8 wherein the accessing step includes the steps of:

if already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, selecting the already loaded code; and

if no already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, dynamically loading code to instantiate an object of the class identified by the unmarshal identifier.

12. The method of claim 10 or 11 wherein the step of dynamically loading code includes the step of:

within the client process,

retrieving from a persistent registry a persistent registry entry indicator of the code to dynamically load, the persistent registry having an entry associating the unmarshal class identifier with the persistent registry entry indicator.

13. A method in a computer system for passing a pointer to an interface of an object from a server process to a client process to enable the client process to invoke function members of the interface, the method comprising the steps of:

within the server process,

instantiating the object, the object having a plurality of interfaces, each interface having a function member, the object further having a marshalling function member for performing object-specific marshalling for a pointer to one of the plurality of interfaces;

identifying an interface of the object to pass to the client process;

invoking the marshalling function member of the object to marshal the identified interface; and

sending to the client process a reference to the object instantiated within the server process and an unmarshal class identifier identifying the class of the proxy object to be instantiated by the client process; and

within the client process,

receiving from the server process the reference to the object instantiated within the server process and the unmarshal class identifier;

instantiating an object of the class identified by the unmarshal class identifier, the object of the class identified by the unmarshal class identifier having an unmarshalling function member;

obtaining a pointer to the object of the class identified by the unmarshal class identifier; and

invoking the unmarshalling function member of the object of the class identified by the unmarshal class identifier using the obtained pointer and passing the reference to the object instantiated within the server proxy, the unmarshalling function member for performing object-specific unmarshalling for the pointer to the identified interface,

whereby the client process may use the pointer to the object of the class identified by the unmarshal class identifier to invoke a function member of the identified interface of the object instantiated within the server process.

14. The method of claim 13 wherein the step of instantiating an object of the class identified by the unmarshal class identifier includes the step of accessing code to instantiate the object.

15. The method of claim 14 wherein the accessing step includes the step of selecting earlier loaded code capable of instantiating an object of the class identified by the unmarshal class identifier.

16. The method of claim 14 wherein the accessing step includes the step of dynamically loading code capable of instantiating an object of the class identified by the unmarshal class identifier.

17. The method of claim 14 wherein the accessing step includes the steps of:

if already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, selecting the already loaded code; and

if no already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, dynamically loading code to instantiate an object of the class identified by the unmarshal identifier.

18. The method of claim 16 or 17 wherein the step of dynamically loading code includes the step of:

within the client process,

retrieving from a persistent registry a persistent registry entry indicator of the code to dynamically load, the persistent registry having an entry associating the unmarshal class identifier with the persistent registry entry indicator.

19. A method in a computer system of passing a pointer to an object from a server process to a client process to enable the client process to invoke function members of the object, the method comprising the steps of:

within the server process,

instantiating the object;

creating a stub for receiving a request to invoke a function member of the object and for invoking the requested function member upon receiving the request, the stub having an identifier; and

sending an unmarshal class identifier identifying the class of a proxy object to instantiate within the client process and the identifier of the stub to the client process; and

within the client process,

receiving the unmarshal class identifier and the identifier of the stub from the server process;

accessing code to instantiate the proxy object of the class identified by the unmarshal class identifier; and

executing the accessed code, including the substeps of;

instantiating a proxy object of the class identified by the unmarshal class identifier, and

initializing the proxy object to contain a reference to the identified stub so that when the proxy object receives requests to invoke a function member of the object, the proxy object sends the request to the identified stub; and

obtaining a pointer to the instantiated proxy object,

wherein the client process may use the pointer to the proxy object to invoke function members of the object instantiated within the server process.

20. The method of claim 19 wherein the accessing step includes the step of selecting earlier loaded code capable of instantiating an object of the class identified by the unmarshal class identifier.

21. The method of claim 19 wherein the accessing step includes the step of dynamically loading code capable of instantiating an object of the class identified by the unmarshal class identifier.

22. The method of claim 19 wherein the accessing step includes the steps of:

if already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, selecting the already loaded code; and

if no already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, dynamically loading code to instantiate an object of the class identified by the unmarshal identifier.

23. The method of claim 21 or 22 wherein the step of dynamically loading code includes the step of:

within the client process,

retrieving from a persistent registry a persistent registry entry indicator of the code to dynamically load, the persistent registry having an entry associating the unmarshal class identifier with the persistent registry entry indicator.

24. A method in a computer system of passing a pointer to an object from a server process to a client process to enable the client process to invoke function members of the object, the method comprising the steps of:

within the server process,

instantiating the object, the object having a marshalling function member for performing object-specific marshalling for a pointer to the object;

invoking the marshalling function member of the object to marshal the identified interface; and

sending to the client process a reference to the object instantiated within the server process and an unmarshal class identifier identifying the class of a proxy object to instantiate in the client process; and

within the client process,

receiving from the server process the reference to the object instantiated within the server process and the unmarshal class identifier;

accessing code to instantiate the object of the class identified by the unmarshal class identifier;

executing the accessed code to instantiate an object of the class identified by the unmarshal class identifier, the object of the class identified by the unmarshal class identifier having an unmarshalling function member;

obtaining a pointer to the object of the class identified by the unmarshal class identifier; and

invoking the unmarshalling function member of the object of the class identified by the unmarshal class identifier using the obtained pointer and passing the reference to the object instantiated within the server process, the unmarshalling function member for performing object-specific unmarshalling for the pointer to the object,

whereby the client process may use the pointer to the object of the class identified by the unmarshal class identifier to invoke function members of the object instantiated within the server process.

25. The method of claim 24 wherein the accessing step includes the step of selecting earlier loaded code capable of instantiating an object of the class identified by the unmarshal class identifier.

26. The method of claim 24 wherein the accessing step includes the step of dynamically loading code capable of instantiating an object of the class identified by the unmarshal class identifier.

27. The method of claim 24 wherein the accessing step includes the steps of:

if already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, selecting the already loaded code; and

if no already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, dynamically loading code to instantiate an object of the class identified by the unmarshal identifier.

28. The method of claim 26 or 27 wherein the step of dynamically loading code includes the step of:

within the client process,

retrieving from a persistent registry a persistent registry entry indicator of the code to dynamically load, the persistent registry having an entry associating the unmarshal class identifier with the persistent registry entry indicator.

29. A method in a computer system for passing a pointer to an object from a server process to a first client process and from the first client process to a second client process to enable the client process to invoke function members of the object, the method comprising the steps of:

within the server process,

instantiating the object;

creating a stub for receiving a request to invoke a function member of the object and for invoking the requested function member upon receiving the request, the stub having an identifier; and

sending an unmarshal class identifier identifying the class of an object to be instantiated in the first and second client processes and the identifier of the stub to the first client process;

within the first client process,

receiving the unmarshal class identifier and the identifier of the stub from the server process;

accessing code to instantiate a first proxy object of the class identified by the unmarshal class identifier;

executing the accessed code, including the substeps of;

instantiating a first proxy object of the class identified by the unmarshal class identifier and having a marshalling function member to specify that the identifier of the stub is to be sent to the second client process, and

initializing the first proxy object to contain a reference to the identified stub so that when the first proxy object receives requests from the first client process to invoke a function member of the object, the first proxy object sends the request to the identified stub;

obtaining a pointer to the first proxy object;

invoking the marshalling function member of the proxy object; and

sending the unmarshal class identifier and the identifier of the stub to the second client process; and

within the second client process,

receiving the unmarshal class identifier and the identifier of the stub from the first client process;

accessing code to instantiate a second proxy object of the class identified by the unmarshal class identifier;

executing the accessed code, including the substeps of;

instantiating a second a proxy object of the class identified by the unmarshal class identifier, and

initializing the second proxy object to contain a reference to the identified stub so that when the second proxy object receives requests from the second client process to invoke a function member of the object, the second proxy object sends the request to the identified stub; and

obtaining a pointer to the second proxy object,

whereby the first client process may use the pointer to the first proxy object to invoke function members of the object instantiated within the server process and the second client process may use the pointer to the second proxy object to make function members of the object instantiated in the server process.

30. The method of claim 29 wherein the accessing steps each include the step of selecting earlier loaded code capable of instantiating an object of the class identified by the unmarshal class identifier.

31. The method of claim 29 wherein the accessing steps each include the step of dynamically loading code capable of instantiating an object of the class identified by the unmarshal class identifier.

32. The method of claim 29 wherein the accessing steps each include the steps of:

if already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, selecting the already loaded code; and

if no already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, dynamically loading code to instantiate an object of the class identified by the unmarshal identifier.

33. The method of claim 31 or 32 wherein the step of dynamically loading code includes the step of:

within each of the client processes,

retrieving from a persistent registry a persistent registry entry indicator of the code to dynamically load, the persistent registry having an entry associating the unmarshal class identifier with the persistent registry entry indicator.

34. The method of claim 29 wherein the object has a plurality of interfaces and the pointer to the object is a pointer to one of the interfaces of the object.

35. A method in a computer system of passing a pointer to an object of a selected class from a server process to a client process to enable the client process to invoke function members of the object, the method comprising the steps of:

within the server process,

instantiating the object in shared memory that is accessible by the server process and the client process, the instantiated object having a data access function member to access data members of the object;

storing an identifier of the selected class in a message as an unmarshal class identifier;

invoking a marshalling function member of the object instantiated within the server process to store a pointer to data members of the object in the message; and

sending the message to the client process; and

within the client process,

receiving the message from the server process;

retrieving the unmarshal class identifier from the message;

accessing code to instantiate an object of the class identified by the unmarshal class identifier;

executing the accessed code to instantiate an object of the class identified by the unmarshal class identifier, thereby instantiating an object of the selected class, the object of the class identified by the unmarshal class identifier having an unmarshalling function member;

obtaining a pointer to the instantiated object of the class identified by the unmarshal class identifier; and

invoking the unmarshalling function member of the object of the class identified by the unmarshal class identifier, including the substeps of;

retrieving from the message the pointer to data members of the object instantiated within the server process, and

storing in the object of the class identified by the unmarshal class identifier the retrieved pointer to the data members so that the data access function member of the object of the class identified by the unmarshal class identifier can access the data members in shared memory.

36. The method of claim 35 wherein the unmarshal class identifier identifies the same class as the object instantiated by the server process.

37. The method of claim 35 wherein the object instantiated by the server has a plurality of interfaces and the pointer to the object is a pointer to one of the interfaces of the object.

38. The method of claim 35 wherein the accessing step includes the step of selecting earlier loaded code capable of instantiating an object of the class identified by the unmarshal class identifier.

39. The method of claim 35 wherein the accessing step includes the step of dynamically loading code capable of instantiating an object of the class identified by the unmarshal class identifier.

40. The method of claim 35 wherein the accessing step includes the steps of:

if already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, selecting the already loaded code; and

if no already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, dynamically loading code to instantiate an object of the class identified by the unmarshal identifier.

41. The method of claim 39 or 40 wherein the step of dynamically loading code includes the step of:

within the client process,

retrieving from a persistent registry a persistent registry entry indicator of the code to dynamically load, the persistent registry having an entry associating the unmarshal class identifier with the persistent registry entry indicator.

42. A method in a computer system of passing a pointer to an immutable object having data members and function members from a server process to a client process, the method comprising the steps of:

within the server process,

instantiating the immutable object;

storing an unmarshal class identifier in a message;

invoking a marshalling function member of the immutable object to store the data members of the object in the message; and

sending the message to the client process; and

within the client process,

receiving the message from the server process;

retrieving the unmarshal class identifier from the message;

accessing code to instantiate an object of the class identified by the unmarshal class identifier;

executing the accessed code to instantiate an object of the class identified by the unmarshal class identifier, the object of the class identified by the unmarshal class identifier having an unmarshalling function member; and

invoking the unmarshalling function member of the object of the class identified by the unmarshal class identifier, including the substeps of;

retrieving the data members from the message, and

storing the retrieved data members in the object of the class identified by the unmarshal class identifier so that the function members of the object of the class identified by the unmarshal class identifier can access the data members of the immutable object.

43. The method of claim 42 wherein the immutable object has a class, and wherein the unmarshal class identifier identifies the class of the immutable object.

44. The method of claim 42 wherein the immutable object has a plurality of interfaces and the pointer to the immutable object is a pointer to one of the interfaces of the immutable object.

45. The method of claim 42 wherein the accessing step includes the step of selecting earlier loaded code capable of instantiating an object of the class identified by the unmarshal class identifier.

46. The method of claim 42 wherein the accessing step includes the step of dynamically loading code capable of instantiating an object of the class identified by the unmarshal class identifier.

47. The method of claim 42 wherein the accessing step includes the steps of:

if already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, selecting the already loaded code; and

if no already loaded code is capable of instantiating an object of the class identified by the unmarshal class identifier, dynamically loading code to instantiate an object of the class identified by the unmarshal identifier.

48. The method of claim 46 or 47 wherein the step of dynamically loading code includes the step of:

within the client process,

retrieving from a persistent registry a persistent registry entry indicator of the code to dynamically load, the persistent registry having an entry associating the unmarshal class identifier with the persistent registry entry indicator.

49. A method in a computer system for performing a function call from a server process to a function within a client process, the function call having an in parameter that is a pointer to an interface of a real object instantiated within the server process, the interface of the real object having a function member, the method comprising the steps of:

within the server process,

creating a stub for receiving a request invoke the function member;

marshalling an identifier of the stub into a message; and

sending the message to the client process; and

within the client process,

receiving the message from the server process;

unmarshalling the identifier of the stub;

creating a proxy for receiving the request to invoke the function member from the client process and sending it to the stub identified by the unmarshalled identifier;

obtaining a pointer to the created proxy; and

calling the function within the client process, passing the obtained pointer to the created proxy as an in parameter.

50. A method in a computer system for performing a function call from a client process to a function within a server process, the function call having an out parameter that is a pointer to an interface of a real object instantiated within the server process, the interface of the real object having a function member, the method comprising the steps of:

within the client process,

initiating a call to the function within the server process;

within the server process,

calling the function within the client process, the function producing the out parameter that is a pointer to the interface of the real object;

creating a stub for receiving a request invoke the function member;

marshalling an identifier of the stub into a message; and

sending the message to the client process; and

within the client process,

receiving the message from the server process;

unmarshalling the identifier of the stub;

creating a proxy for receiving the request to invoke the function member from the client process and sending it to the stub identified by the unmarshalled identifier;

obtaining a pointer to the created proxy; and

returning the obtained pointer to the created proxy as an out parameter of the function call initiated within the client process.