Specification of package Corba.Transport.Shm

 ========================================================================= --
 ===                                                                   === --
 ===                 Top Graph'X CORBA Implementation                  === --
 ===                                                                   === --
 ===                 Copyright (c) 2001, Top Graph'X.                  === --
 ===                                                                   === --
 ===                     --- Copyright Notice ---                      === --
 ===                                                                   === --
 ===    This software is protected as an unpublished work under the    === --
 ===     Copyright Act of 1976.  All rights reserved.  Top Graph'X.    === --
 ===                                                                   === --
 ========================================================================= --

with Tgx.Shared_Memory ;
with Corba.Iop ;
package Corba.Transport.Shm is
   Name : constant Protocol_Name := "SHM" ;
   Id   : constant := Corba.Iop.Tag_Memory_Iop ;

   type Object is new Corba.Transport.Connected with null record ;
   type Object_Ptr is access all Object'class ;

    Build the URL from Host, Path and Server
   function Url ( Host_Name : in Standard.String ;
                  Path      : in Standard.String ;
                  Server    : in Tgx.Shared_Memory.Channel_Id )
      return Standard.String ;

    Create a server connection corresponding to the given URL
   function Create_Server ( Self : access Object ;
                            Url  : in Standard.String)
      return Tgx.Ios.Io_Server_Access ;

    Create a data connection corresponding to the given URL
   function Connection ( Self : access Object ;
                         Url  : in Standard.String)
      return Tgx.Ios.Io_Connection_Access ;

    Build the transport IOR profile header for the given URL
    It is aligned on a four-bytes boundary and contains only the transport
    information (e.g. host name and TCP port number for IIOP profile)
   function Get_Profile_Header
      ( Self   : access Object ;
        Url    : in Standard.String )
      return Corba_Ios.Stream_Element_Array ;

    Extract the URL from the IOR stream
    Index is aligned on a four-bytes boundary and points at the beginning
    of the transport information
    (e.g. host name and TCP port number for IIOP profile)
    Index is updated to the last byte index of the transport information
   function Get_Url ( Self   : access Object ;
                      Swap   : in Boolean ;  Indicate the need to swap bytes
                      Data   : in Corba_Ios.Stream_Element_Array ;
                      Index  : access Corba_Ios.Stream_Element_Offset)
      return Standard.String ;

end Corba.Transport.Shm ;

List of definition uses