Abstract:
There is disclosed a method, apparatus, computer program and computer program product for facilitating access by an application to a data structure comprising a plurality of objects. A request is received from the application which initiates the return of the data structure. A handle is assigned to each of at least some of the plurality of objects. Objects in the data structure are retrieved and the application is informed of assigned handles thereby enabling the application to access retrieved objects.

Description:
FIELD OF THE INVENTION  
       [0001]     The invention relates to asynchronous application programming interfaces (APIs) and more particularly to the return of objects from a call to such an API.  
       BACKGROUND OF THE INVENTION  
       [0002]     As will be familiar to those skilled in the art of programming, a program often comprises function calls which provide a return value(s) for subsequent use in the program. A synchronous program will typically wait for a function to return any values before continuing with its processing. Certain environments however cannot afford such waiting—they require almost instantaneous results. In for example a gaming environment, users are typically not prepared to wait 5 seconds whilst a screen updates. Good performance is required and yet games applications typically use a non-threaded model of programming thus preventing the use of parallel processing to achieve required performance levels. (This is because threads are typically under the control of the operating system and so do not therefore permit tight enough control by the games application programmer.)  
         [0003]     To help achieve acceptable performance levels, asynchronous APIs and handles are often used. A handle is an abstract reference (label) which is associated with a function&#39;s return value and which can then be used to access that return value.  
         [0004]     For example, a user program (application) may call function y on some API which may need to return value r. The time taken to process the request and actually return the value r may however be too long, and will have too large an impact on the user program. Instead, when the function is called, it returns a handle “handle_r”, which is an abstract reference to the actual return value, r, which will initially be unavailable. The work of actually processing the request made as a result of that function, and thus retrieving r, will not be immediately carried out. Instead, the user program will later provide the API with x milliseconds in which to actually do that work, and to obtain the return value r. Once the API&#39;s allotted time slot has expired, the user program will then query handle_r to determine whether it resolves to the return value r. If the answer is no, then the user application may do some additional processing, such as redrawing a screen, before requesting that the API re-attempt to obtain r and also before handle_r is queried again. The user application can periodically query the handle (interspersing this with additional processing) until handle_r finally resolves to the result r. Note, when r is finally returned from function y, it is stored in a block of memory and an entry in a lookup table is then resolved such that “handle_r” references the block of memory containing r. This time, when the user program queries handle_r, it is presented with access to r. Because the user application only provides the API with a short period of time in which to retrieve the object, the delay whilst this is happening is not discernible to a user.  
         [0005]     In reality (given a good network connection) the return of a single value (simple object) should be achieved within the x milliseconds allowed for. Sometimes however API calls return more complex data structures. For example, a call may return a linked list of items, or a tree of items. Complex data structures are composed of many individual objects. These objects are then linked to each other via the use of object pointers, and the complex data structure is created as a result of this linkage.  
         [0006]     When using asynchronous APIs, a function is not able to immediately return a result. Rather, a handle is returned instead. This handle is associated with an eventual return value (i.e. complex structure) generated by the asynchronous API (this value being the result of the initial function call). The user is informed of the return of this result and the association with the handle via a change in the handle&#39;s “state” (e.g. it moves from an “Empty” to a “Complete” state). The user then uses the handle to access the return value. As far as the user is concerned, the handle is not resolvable (i.e. is in the “Empty” state) until the structure is complete. The program need however not be blocked since as before it may provide the API with x milliseconds to retrieve n objects. During that time, the API may retrieve only 2 of those objects. These will be associated with a handle but to the user this handle does not yet resolve to a structure because all objects in the structure have not yet been retrieved. The program will continue its processing, will periodically request that the API retrieves more objects and will query the handle to determine whether it is resolvable. This can however take time (especially where network connections are involved and when large structures need to be retrieved) and this can be undesirable.  
       SUMMARY OF THE INVENTION  
       [0007]     According to a first aspect the invention provides a method for facilitating access by an application to a data structure comprising a plurality of objects, the method comprising the steps of: receiving a request from the application initiating the return of the data structure; assigning a handle to each of at least some of the plurality of objects; retrieving objects in the data structure; informing the application of assigned handles thereby enabling the application to access retrieved objects.  
         [0008]     Note, no order is intended to be implied by the above. For example, objects could be retrieved and then handles assigned or handles could be assigned and then resolved as and when the associated objects are retrieved.  
         [0009]     Note, objects may be retrieved via an intermediary.  
         [0010]     Previously a requesting application had to wait for the entire data structure (and the objects it contained) to be returned before objects in the data structure could be accessed. With the present solution it is now possible to provide access to individual objects in a data structure as and when such objects are retrieved. This enables an application to work with retrieved objects whilst other objects are being retrieved/in an interim before more objects in the data structure are retrieved.  
         [0011]     In a preferred embodiment, the request comprises a function call which is operable to return the data structure to the application.  
         [0012]     In a preferred embodiment responsive to retrieving an object, the retrieved object is assigned to a memory location and a handle is associated with the memory location containing that object. A lookup table can be used to associate each handle with an object/with a memory location containing an object.  
         [0013]     In one embodiment, more than one object may be stored in the same block of memory and consequently one handle may be used to reference any objects stored within a particular memory block (logically the block of memory becomes one object).  
         [0014]     In a preferred embodiment a request is received from the application to access a retrieved object. The request preferably uses the handle associated with the retrieved object. Preferably access is then provided to the requested object (even though all objects in the data structure may not have yet been retrieved).  
         [0015]     In a preferred embodiment, a request may be received to free up a memory location associated with a retrieved object. The memory location is then freed—for example, the memory location is permitted to be overwritten with new data. This is particularly advantageous in the situation where there is not enough memory available to accommodate the complete data structure. The application may determine that certain of the retrieved objects are not required and may then request that any memory allocated to these objects is freed up. Such freed memory can then be used for other objects in the data structure.  
         [0016]     According to a second aspect, the invention provides a method for accessing objects in a data structure comprising: providing a request to an asynchronous application programming interface initiating the return of a data structure; receiving notification of a handle assigned to an object in the data structure; and using the notified handle to access the corresponding object.  
         [0017]     Note, the same handle may be assigned to more than one object—see above.  
         [0018]     Preferably, it is necessary to periodically query the handle to determine whether it is resolvable to a retrieved object.  
         [0019]     Preferably the request is a function call which is operable to return the data structure.  
         [0020]     Preferably it is possible to access an object in the data structure using an assigned handle. Further, it is preferably possible to use an accessed object to determine the handle assigned to another object in the data structure. For example, a handle to the next object in the data structure (e.g. where the data structure is a linked list) may be stored with the accessed object.  
         [0021]     According to a preferred embodiment, it is possible to determine that an accessed object is no longer required. Responsive to determining that the accessed object is no longer required, it is preferably possible to request that memory associated with the accessed object is freed. This is useful since certain objects may not be required by the application (or may only temporarily be required). Memory is frequently at a premium and so it is extremely advantageous to be able to free up memory containing objects that are no longer being accessed.  
         [0022]     Note, this is applicable to an implementation which provides for a “non-destructive” read—i.e. where the object remains stored in memory associated with the API, even after it is accessed, and is only destroyed when a function call explicitly freeing up that handle is made.  
         [0023]     In another embodiment, destructive reads are provided for—i.e. when a handle is used to retrieve an object for an application, the memory associated with that object is freed, therefore meaning that version of the object that the application now holds is the only one that exists. This also therefore means that that handle cannot be referenced again.  
         [0024]     According to a third aspect, the invention provides apparatus for facilitating access by an application to a data structure comprising a plurality of objects, the apparatus comprising: means for receiving a request from the application initiating the return of the data structure; means for assigning a handle to each of at least some of the plurality of objects; means for retrieving objects in the data structure; means for informing the application of assigned handles thereby enabling the application to access retrieved objects.  
         [0025]     According to a fourth aspect, the invention provides apparatus for accessing objects in a data structure comprising: means for providing a request to an asynchronous application programming interface initiating the return of a data structure; means for receiving notification of a handle assigned to an object in the data structure; and means for using the notified handle to access the corresponding object.  
         [0026]     According to a fifth aspect, the invention provides a computer program comprising program code means adapted to perform the method of the first or second aspect when said program is run on a computer.  
         [0027]     According to a sixth aspect, the invention provides a computer program product stored on a computer readable storage medium, the computer program product comprising instructions which, when executed on a data processing host, cause said host to carry out the method of the first or second aspect. 
     
    
     BRIEF DESCRIPTION OF THE DRAWINGS  
       [0028]     A preferred embodiment of the present invention will now be described, by way of example only, and with reference to the following drawings:  
         [0029]      FIG. 1  is a flow chart showing the processing of the present invention in accordance with a preferred embodiment; and  
         [0030]      FIG. 2  illustrates a component diagram in accordance with a preferred embodiment of the present invention. 
     
    
     DETAILED DESCRIPTION  
       [0031]     The figures shows the processing of the present invention, in accordance with a preferred embodiment, from the perspective of both an application (e.g. a user application) and an asynchronous application programming interface (API). Both figures should be read in conjunction with one another.  
         [0032]     A user application  200  calls a function at step  10  (via the function caller component  210 ) which will eventually return a complex structure comprising a plurality of objects. For example the user application may be commerce-based, and will thus enable a user to move around a virtual store and query a catalogue of items stocked by the store. The structure returned by a function may, for example, be a subset of items within the catalogue (a linked list in this case, although the invention is not limited to such).  
         [0033]     When the API  260  receives the function call, it determines that the function returns a complex structure and assigns a handle at step  100  (handle assignor  270 ) to the first item in the structure. The API adds the handle into a lookup table (step  110 —lookup component  280 ). The handle resolves to nothing at this point. This handle is then returned to (step  120 —handle returner  235 ) and received by the user application (step  20 —handle receiver  230 ).  
         [0034]     The user application does some work (processing—step  30 —processor  240 ) such as drawing the virtual store. It then calls an execute function at step  40  (function caller — 210 ) and allocates x milliseconds to the API for performing this execute function (shown by the dotted arrow). The execute function is performed by the API (step  130 ) and enables the API to carry out any pending work. (Note, the dotted line indicates that steps  120  and  130  are not directly linked.)  
         [0035]     When the execute function is called by the user application, the API attempts to retrieve the first item in the list (step  140 —item retriever  290 ). Note, this can take some time, especially if network connections etc. are involved.  
         [0036]     When an item is retrieved, it is assigned to a memory location (step  150 —memory assignor  300 ). This memory location is then associated with the handle such that the handle now resolves (step  160 ).  
         [0037]     Some other information, which is not exposed to the user application, is used by the API to determine whether there is another item in the list (step  170 ). For example, the API may retrieve information by which it is informed that this is item  20  of  25 . The API then manipulates the data retrieved into a form which the user application can understand. E.g.:  
                                                             item {                string name;           int cost;           handle next;           }                      
 
         [0038]     If there is another item, then a handle is also assigned to the “next” field of the retrieved item (step  180 —handle assignor  270 ). Thus a handle is stored in memory with this item (step  190  handle assignor  270 ). (Note, if there isn&#39;t another item, then the next field may be assigned a null value or alternatively there may not be such a field.) The handle is also added into the lookup table.  
         [0039]     Note, one embodiment handles may be stored separately but this is preferably only applicable to a linked list embodiment where traversing the list in order is not important.  
         [0040]     The execute function continues until the allotted time period expires (step  195 )—control is then returned to the user application at step  50 . More than one item may be retrieved during the allotted time period.  
         [0041]     Further note, the time period is chosen so that the wait caused to the user application, whilst the API is executing, is not discernible to the user.  
         [0042]     When control is returned by the API to the user application, the user application queries the returned handle to determine whether the handle resolves to an object (steps  50 , 6—handle querier  220 ). If the API has managed to retrieve the associated object, the user application will receive an indication that the handle now resolves—not shown in the figure. The user application will then use the assigned handle to access and extract the retrieved item (step  80 —item extractor  250 ). Note, this may involve accessing the object remotely or actually retrieving the object and storing it locally.  
         [0043]     As previously mentioned, there may be more items in the list. The user application is able to determine the handle to the next item because it is stored with the item that has just been received. This handle is then preferably used to immediately query whether the new handle resolves (i.e. whether the item associated with the handle has yet been retrieved and assigned to a memory location). This is because the execute function may have managed to retrieve more than one item in the x milliseconds allotted to it.  
         [0044]     If the answer is yes, then the handle is used to access this next item and same process continues until it is determined that a handle does not resolve.  
         [0045]     Otherwise the user application does some more work before it once again calls the execute function (step  30 —function caller  210 ).  
         [0046]     In this way, it is possible to gain access to the individual items (objects) in a complex structure. It is no longer necessary to wait for the entire structure to be returned before permitting the user access to the items (objects) within the structure. Rather the user can now see and work with items as and when they are returned by the API. This is advantageous in multiple respects. Allowing a user to work with certain items whilst others are being returned saves time. Further it is useful in situations where it is not possible to allocate enough memory to an entire structure. Memory can be allocated to objects, consumed by a user application and then destroyed when no longer required. Destruction frees up memory for the rest of the structure. For example, the user may not be interested in “shoes” and is thus able to overwrite memory allocated to any returned items which relate to such items.  
         [0047]     Note, handles do not have to be queried immediately control is returned to the user application. Further objects which resolve to queried handles do not have to be retrieved immediately.  
         [0048]     It will be appreciated that whilst the invention has been described in terms of a data structure comprising a linked list, the invention is not limited to such. For example, the data structure may comprise a tree of nodes. To use a binary tree as an example, the root object in the tree would be the first item that would be returned from the API. Each of the two child objects of that root object (since this is a binary tree) would then have handles associated with them.  
         [0049]     Regarding which of the child objects is returned first, this would partly depend on the API and partly on the source that the object is being retrieved from (e.g. from a commerce service, across the network—certain objects may be retrieved quicker than others because of a better network connection etc.). The API would have to build up its own internal representation of the tree and correctly link all those handles, as and when they&#39;re returned. The user of the API would then traverse the tree by just accessing each child (and therefore traversing each branch of the tree) as and when the handles for those child resolve into a state that indicates that the object is now available to be retrieved.  
         [0050]     The preferred embodiment assumes that when an object is retrieved, it is retrieved in its entirety. This object retrieval can be subdivided into two steps: receipt of the data that represents the object and parsing of that data to provide the actual object. In some embodiments the parsing of the data can be very expensive. Those embodiments can be further improved by avoiding the parsing step for those objects which the requesting user application does not access. This is achieved by delaying the parsing step until the requesting user application actually accesses the handle associated with the requested object.