Name ISLE_SIFactory GUID

The interface allows creation of service instances for a specified service type and for a specified role (SLE service provider or SLE service user). Following creation, the service instance must be configured using its administrative interface. When the association is no longer needed, the service element component must be instructed to destroy the service instance. In addition, clients must make sure that all references on all interfaces of the service instance have been released.

#include

#include

#include

interface ISLE_ServiceInform;
#define IID_ISLE_SIFactory_DEF { 0xbb4dda2e, 0x54cd, 0x11d8, \

{ 0x9c, 0xf5, 0x0, 0x4, 0x76, 0x1e, 0x8c, 0xfb } }

{

virtual HRESULT

SLE_ApplicationIdentifier srvType,

SLE_VersionNumber version,

SLE_AppRole role,

ISLE_ServiceInform* pclientIf,

void** ppv ) = 0;

virtual HRESULT

DestroyServiceInstance( IUnknown* psi ) = 0;

};

Methods

HRESULT CreateServiceInstance( const GUID& iid,
SLE_ApplicationIdentifier srvType,
SLE_VersionNumber version,
SLE_AppRole role,
ISLE_ServiceInform* pclientIf,
void** ppv );

Creates a new service instance for the requested SLE service type, supporting the requested role (SLE service provider or SLE service user). Returns a pointer to the requested interface of the service instance. If the component does not support the service type, the requested role, or the requested interface identifier returns an error.

For service instances in the user (initiator) role the version of the SLE service must be specified and this specification will be included into the BIND invocation. On the provider (responder) side the version number is defined by the BIND invocation received from the user and checked against the list of supported version numbers in the configuration database of the API Proxy. Therefore the argument is ignored and should be set to zero.

Arguments

iid the identifier for the required interface

srvType the SLE service type to be supported by the service instance

version for the user (initiator) role defines the version number of the SLE service type to be used; for the provider (responder) side this argument is ignored and should be set to zero

role the role (user or provider) to be supported by the service instance

pclientIf pointer to the interface the service instance shall use to pass operations to the client

ppv pointer to the requested interface of the service instance

Result codes

S_OK the service instance object has been created

SLE_E_STATE the service element has not been started

SLE_E_INVALIDID the version number is zero for the role ‘user’

E_NOTIMPL the service type or the version or the role is not supported by the service element

E_NOINTERFACE the interface is not supported by an association object

HRESULT DestroyServiceInstance( IUnknown* psi );

Destroys a service instance created by this interface.

38. 
    SLE Service Instance Administrative Interface
    

The interface is provided for configuration of service instances. It can be used for instances supporting the provider role or the user role. For instances supporting the user role not all parameters need to be set.

Clients must specify the individual parameters using the method foreseen for the parameter. Depending on the service type, further parameters may have to be supplied using the service type-specific configuration interface. When all parameters have been supplied, the method ConfigCompleted() must be called. The service instance then verifies that the configuration is complete and consistent and performes all actions required to start nominal operation. If the method ConfigCompleted() returns with success, the service instance is ready for operation.

As a general precondition, configuration parameters must not be modified after a successful return of the method ConfigCompleted(). The effect of an attempt to set a parameter when the initial configuration has completed, is undefined.

The interface provides read access to all configuration parameters, including those defined in the create request to the Service Instance Factory. The value returned by a call to the read methods before configuration has been completed, is generally undefined.

Synopsis

#include

#include

#include

interface ISLE_SII;

interface ISLE_Time;

{ 0x9c, 0xf5, 0x0, 0x4, 0x76, 0x1e, 0x8c, 0xfb } }

interface ISLE_SIAdmin : IUnknown

{

virtual void

virtual void

Put_ServiceInstanceId( ISLE_SII* id ) = 0;

virtual void

Set_PeerIdentifier( const char* id ) = 0;

virtual void

Set_ProvisionPeriod( const ISLE_Time* start,

const ISLE_Time* stop ) = 0;

virtual void

Set_BindInitiative( SLE_AppRole role ) = 0;

virtual void

Set_ResponderPortIdentifier( const char* portId ) = 0;

virtual void

Set_ReturnTimeout( int timeout ) = 0;

virtual HRESULT

ConfigCompleted() = 0;

virtual SLE_ApplicationIdentifier

Get_ServiceType() const = 0;

virtual SLE_VersionNumber

Get_Version() const = 0

virtual SLE_AppRole

Get_Role() const = 0;

virtual const ISLE_SII*

Get_ServiceInstanceIdentifier() const = 0;

virtual const char*

Get_PeerIdentifier() const = 0;

virtual const ISLE_Time*

Get_ProvisionPeriodStart() const = 0;

virtual const ISLE_Time*

Get_ProvisionPeriodStop() const = 0;

virtual SLE_AppRole

Get_BindInitiative() const = 0;

virtual const char*

Get_ResponderPortIdentifier() const = 0;

virtual int

Get_ReturnTimeout() const = 0;

};

Methods__void_Set_ServiceInstanceId(_const_ISLE_SII_id_);'>Methods

void Set_ServiceInstanceId( const ISLE_SII& id );

Sets the service instance identifier copying the input argument.

Sets the service instance to the input argument. The argument will be deleted by the service instance object.

Sets the identifier of the peer application.

Sets the scheduled provisioning period according the start and stop times passed as arguments. If the start time is NULL, the service instance assumes immediate start of the provision period. If the stop time is NULL, the service instance provision period never expires.

Specifies whether user-initiated binding or server-initiated binding shall be used.

Sets the port identifier for the responding application.

Sets the timeout value in which a return for confirmed operations must arrive. The timeout argument is passed in units of seconds.

Checks the configuration of the service element on completeness and consistency and performs all actions needed to start nominal operation. The method includes checking of all service type-specific parameters and takes into account the role (user or provider) of the service instance. This method must not be called again after successful completion indicated by a result code of S_OK.

Returns the service type supported by the service instance.

Returns the version number of the service type supported by the service instance. For the role ‘provider’ returns the value extracted from the received BIND invocation when the service instance is bound and zero when the service instance is not bound.

Returns the application role (user or provider) assumed by the service instance.

Returns the service instance identifier set in the object, or NULL if no identifier has been set.

Returns the peer identifier set in the service instance or NULL when not yet configured.

Returns the provisioning start time set in the service instance or NULL when not yet configured.

Returns the provisioning stop time set in the service instance or NULL when not yet configured.

Returns the bind initiative (user-initiated or provider-initiated) set for the service instance.

Returns the logical port identifier set in the service instance or NULL when not yet configured.

Returns the return timeout period set in the service instance or 0 when not yet configured.

39. 
    SLE Service Interfaces
    
    1. 
       Service Proxy Interface
       

The interface is provided to the proxy for transfer of operation invocations and returns on a single association. In addition, it provides a method to signal transfer of a PDU if that has been requested via the complementary interface ISLE_SrvProxyInitiate.

The PDUs passed via this interface are generally unchecked. The only checks performed by the proxy are that the PDU is supported by the service type and is properly coded. Reception of an invalid PDU via this interface shall not cause the function to be rejected. The provider of the interface must either generate the appropriate operation return or abort the association.

Calls to this interface shall only be rejected when the client misbehaves. For instance, passing of an invocation other than BIND in the state unbound is such an error.

#include

#include

interface ISLE_Operation;

interface ISLE_ConfirmedOperation;
#define IID_ISLE_SrvProxyInform_DEF { 0x24396fc4, 0xcd99, 0x11d2, \

{ 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } }

{

virtual HRESULT

unsigned long seqCount = 0 ) = 0;

virtual HRESULT

InformOpReturn( ISLE_ConfirmedOperation* poperation,

unsigned long seqCount = 0 ) = 0;

virtual HRESULT

PDUTransmitted( ISLE_Operation* poperation ) = 0;

virtual HRESULT

ProtocolAbort( const SLE_Octet* diagnostic,

size_t size ) = 0;

};

Methods

HRESULT InformOpInvoke( ISLE_Operation* poperation,
unsigned long seqCount = 0 );

Accepts an operation invocation.

Accepts an operation return.

Reports transmission of a PDU as requested via the interface ISLE_SrvProxyInitiate.

Reports failure of the communications system for the association.

2. 
   Service Application Interface
   

The interface provides the methods to pass operation invocations and returns to a service instance in the API Service Element. The requests are checked and an error is returned in case of incomplete or inconsistent definitions or if the PDU is not valid in the current state of the service instance. (For the definition of the state table see section 4.) A positive return code of the methods ensures that the PDU has been queued for transmission. It does not indicate that the PDU has been actually transmitted.

For the following special PDUs, the interface may return the code SLE_S_SUSPEND indicating that further transfer of data shall be suspended:

1. 
   Transfer Data Invocation for forward Services;
   
2. 
   Transfer Data Invocation for Return Services when the delivery mode is either complete online or offline.
   

#include

#include

interface ISLE_Operation;

interface ISLE_ConfirmedOperation;
#define IID_ISLE_ServiceInitiate_DEF { 0x7b425727, 0xd32d, 0x11d2, \

{ 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } }

{

virtual HRESULT

unsigned long seqCount = 0 ) = 0;

virtual HRESULT

InitiateOpReturn( ISLE_ConfirmedOperation* poperation,

unsigned long seqCount = 0 ) = 0;

virtual SLE_SIState

Get_SIState() const = 0;

};

Methods

Accepts an operation invocation for transfer. If the operation is confirmed, the operation object will be passed back via the complementary interface when the return is received.

Accepts an operation return for transfer. The operation object must have been passed to the application via the complementary interface.

Returns the current state of the service instance.

40. 
    Service Specific Operation Factory
    

The interface defines a specialized operation object factory provided by service instances in the API Service Element. The interface is able to create operation objects for a given service type and service role. Operation objects created via this interface are ‘pre-configured’ using the data specified for the service instance (see the description of the operation object interfaces for details). Operation objects for common association management (see A.1.26) are created by all service instances.