-
Common Association Management
-
BIND Operation
Name ISLE_Bind
GUID {D020B007-CCD1-11d2-9B44-00A0246D80DB}
Inheritance: IUnknown – ISLE_Operation – ISLE_ConfirmedOperation
File ISLE_Bind.H
The interface provides access to the parameters of the operation BIND. Through its inheritance, it provides access to the parameter ‘invocation identifier’. This parameter is not defined for the BIND operation and must not be used. The API proxy and the API Service Element must exclude this operation from the checks related to invocation identifiers.
The SLE service type and version number applicable for the operation object are defined when the object is created (see ISLE_UtilFactory) and the interface ISLE_Operation provides access to these attributes. This interface defines additional attributes for the SLE service type and version number, which represent the parameters of the SLE BIND operation and can be modified via this interface.
Synopsis
#include
interface ISLE_SII;
#define IID_ISLE_Bind_DEF { 0xd020b007, 0xccd1, 0x11d2, \
{ 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } }
interface ISLE_Bind : ISLE_ConfirmedOperation
{
virtual const char*
Get_InitiatorIdentifier() const = 0;
virtual const char*
Get_ResponderIdentifier() const = 0;
virtual const char*
Get_ResponderPortIdentifier() const = 0;
virtual const ISLE_SII&
Get_ServiceInstanceId() const = 0;
virtual void
Set_InitiatorIdentifier( const char* id ) = 0;
virtual void
Set_ResponderIdentifier( const char* id ) = 0;
virtual void
Set_ResponderPortIdentifier( const char* port ) = 0;
virtual void
Set_ServiceInstanceId( const ISLE_SII& siid ) = 0;
virtual void
Put_ServiceInstanceId( ISLE_SII* psiid ) = 0;
virtual SLE_ApplicationIdentifier
Get_ServiceType() const = 0;
virtual SLE_VersionNumber
Get_VersionNumber() const = 0;
virtual void
Set_ServiceType( SLE_ApplicationIdentifier serviceType ) = 0;
virtual void
Set_VersionNumber( SLE_VersionNumber version ) = 0;
virtual SLE_BindDiagnostic
Get_BindDiagnostic() const = 0;
virtual void
Set_BindDiagnostic( SLE_BindDiagnostic diagnostic ) = 0;
};
Methods
const char* Get_InitiatorIdentifier() const;
Returns the identifier for initiating SLE Application set in the object or NULL if the parameter has not been set.
const char* Get_ResponderIdentifier() const;
Returns the identifier for responding SLE Application set in the object or NULL if the parameter has not been set.
const char* Get_ResponderPortIdentifier() const;
Returns the responder port identifier if currently set in the object. Otherwise returns a NULL pointer.
const ISLE_SII& Get_ServiceInstanceId() const;
Returns the service instance identifier set in the object.
Precondition: service instance identifier is present in the object.
void Set_InitiatorIdentifier( const char* id );
Sets the identifier of the initiating SLE Application.
void Set_ResponderIdentifier( const char* id );
Sets the identifier of the responding SLE Application.
void Set_ResponderPortIdentifier( const char* port );
Sets the initiator port identifier copying the input argument.
void Set_ServiceInstanceId( const ISLE_SII& siid );
Sets the service instance identifier copying the input argument.
void Put_ServiceInstanceId( ISLE_SII* psiid );
Sets the service instance identifier to the input argument. The service instance identifier passed is deleted by the component.
SLE_ApplicationIdentifier Get_ServiceType();
Returns the service type currently stored in the object. This method differs from the inherited method Get_OpServiceType(), which returns the service type for which the operation object was created (see ISLE_UtilFactory and ISLE_Operation).
SLE_VersionNumber Get_VersionNumber() const;
Returns the version number currently set in the object. This method differs from the inherited method Get_OpVersionNumber(), which returns the version of the service type for which the operation object was created (see ISLE_UtilFactory and ISLE_Operation).
void Set_ServiceType( SLE_ApplicationIdentifier serviceType );
Sets the service type to the input argument.
void Set_VersionNumber( SLE_VersionNumber version );
Sets the version to the input argument.
SLE_BindDiagnostic Get_BindDiagnostic();
Returns the bind diagnostic currently set in the object.
void Set_BindDiagnostic( SLE_BindDiagnostic diagnostic );
Sets the result to negative, the diagnostic type to ‘specific’, and the diagnostics to the input argument.
Default Setting of Operation Parameters after Creation
Argument
|
Created directly
|
Created by Service Instance
|
initiator identifier
|
NULL
|
NULL
|
responder identifier
|
NULL
|
as defined for the SI
|
responder port identifier
|
NULL
|
as defined for the SI
|
service instance identifier
|
NULL
|
as defined for the SI
|
service type
|
as requested for creation
|
as defined for the SI
|
version number
|
as requested for creation
|
as defined for the SI
|
bind diagnostic
|
‘invalid’
|
‘invalid’
|
Checking of Invocation Parameters
Argument
|
Required condition
|
responder identifier
|
must be set
|
responder port identifier
|
must be set
|
service instance identifier
|
must be set
|
service type
|
must be set
|
version number
|
must be set
|
The checks defined here include a check on the presence of the responder identifier and therefore apply to the BIND initiating side only. On the responding side, the method VerifyInvocationArguments() should not be called, because it might return an error although the BIND invocation PDU is correct. Calling of this method on the responder side is not necessary, because all arguments are subject to specific tests performed by the components API proxy and API Service Element.
Checking of Return Parameters
Argument
|
Required condition
|
bind diagnostic
|
if the result is negative and the diagnostic type is ‘specific’ must not be ‘invalid’
| -
UNBIND Operation
Name ISLE_Unbind
GUID {7B425720-D32D-11d2-9B44-00A0246D80DB}
Inheritance: IUnknown – ISLE_Operation – ISLE_ConfirmedOperation
File ISLE_Unbind.H
The interface provides access to the parameters of the operation UNBIND. Through its inheritance, it provides access to the parameter ‘invocation identifier’. This parameter is not defined for the UNBIND operation and must not be used. The API proxy and the API Service Element must exclude this operation from the checks related to invocation identifiers.
Synopsis
#include
#define IID_ISLE_Unbind_DEF { 0x7b425720, 0xd32d, 0x11d2, \
{ 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } }
interface ISLE_Unbind : ISLE_ConfirmedOperation
{
virtual SLE_UnbindReason
Get_UnbindReason() const = 0;
virtual void
Set_UnbindReason( SLE_UnbindReason reason ) = 0;
};
Methods
SLE_UnbindReason Get_UnbindReason() const;
Returns the unbind reason currently set in the object.
void Set_UnbindReason( SLE_UnbindReason reason );
Sets the unbind reason to the input argument.
Default Setting of Operation Parameters after Creation
Argument
|
Created directly
|
Created by Service Instance
|
unbind reason
|
‘invalid’
|
‘invalid’
|
Checking of Invocation Parameters
Argument
|
Required condition
|
unbind reason
|
must not be ‘invalid’
|
Checking of Return Parameters
No checks are defined for parameters handled by this interface.
-
PEER-ABORT Operation
Name ISLE_PeerAbort
GUID {7B425721-D32D-11d2-9B44-00A0246D80DB}
Inheritance: IUnknown – ISLE_Operation
File ISLE_PeerAbort.H
The interface provides access to the parameters of the operation PEER ABORT. Through its inheritance, it provides access to the parameter ‘invoker credentials’. This parameter is not defined for the PEER-ABORT operation and must not be used. The proxy must ensure that authentication is not applied to the PEER ABORT operation, even if the parameter is set in the operation object by mistake.
In addition to the parameters defined for the SLE operation, objects exporting this interface store the originator of the abort, which can be the peer system, the local proxy, the local service element, or the local application. This information is not forwarded across the association.
Synopsis
#include
#define IID_ISLE_PeerAbort_DEF { 0x7b425721, 0xd32d, 0x11d2, \
{ 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } }
interface ISLE_PeerAbort : ISLE_Operation
{
virtual SLE_PeerAbortDiagnostic
Get_PeerAbortDiagnostic() const = 0;
virtual void
Set_PeerAbortDiagnostic( SLE_PeerAbortDiagnostic diagnostic ) = 0;
virtual SLE_AbortOriginator
Get_AbortOriginator() const = 0;
virtual void
Set_AbortOriginator( SLE_AbortOriginator originator ) = 0;
};
Methods
SLE_PeerAbortDiagnostic Get_PeerAbortDiagnostic() const;
Returns the special diagnostics for PEER-ABORT, if these are available. The type of the diagnostics can be checked by the method provided by the base class.
void Set_PeerAbortDiagnostic( SLE_PeerAbortDiagnostic diagnostic );
Sets the PEER-ABORT diagnostic, and the diagnostic type to ‘specific’.
SLE_AbortOriginator Get_AbortOriginator() const;
Returns the originator of the abort.
void Set_AbortOriginator( SLE_AbortOriginator originator );
Sets the originator of the abort to the input argument.
Default Setting of Parameters after Creation
Argument
|
Created directly
|
Created by Service Instance
|
peer abort diagnostics
|
‘invalid’
|
‘invalid’
|
abort originator
|
‘invalid’
|
‘application’
|
Checking of Invocation Parameters
No checking is performed.
-
Other Common Operations
-
STOP Operation
Name ISLE_Stop
GUID {7B425723-D32D-11d2-9B44-00A0246D80DB}
Inheritance: IUnknown – ISLE_Operation – ISLE_ConfirmedOperation
File ISLE_Stop.H
This is an empty interface, as all functionality required is covered by the inherited interfaces. The specific interface exists in order to attach the required identifier.
Synopsis
#include
#define IID_ISLE_Stop_DEF { 0x7b425723, 0xd32d, 0x11d2, \
{ 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } }
interface ISLE_Stop : ISLE_ConfirmedOperation {};
Methods
This interface does not define any new methods.
-
SCHEDULE STATUS REPORT Operation
Name ISLE_ScheduleStatusReport
GUID {7B425724-D32D-11d2-9B44-00A0246D80DB}
Inheritance: IUnknown – ISLE_Operation – ISLE_ConfirmedOperation
File ISLE_ScheduleStatusReport.H
Synopsis
#include
#define IID_ISLE_ScheduleStatusReport_DEF \
{ 0x7b425724, 0xd32d, 0x11d2, \
{ 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } }
interface ISLE_ScheduleStatusReport : ISLE_ConfirmedOperation
{
virtual SLE_ReportRequestType
Get_ReportRequestType() const = 0;
virtual void
Set_ReportRequestType( SLE_ReportRequestType type ) = 0;
virtual SLE_ReportingCycle
Get_ReportingCycle() const = 0;
virtual void
Set_ReportingCycle( SLE_ReportingCycle cycle ) = 0;
virtual SLE_ScheduleStatusReportDiagnostic
Get_SSRDiagnostic() const = 0;
virtual void
Set_SSRDiagnostic( SLE_ScheduleStatusReportDiagnostic diagnostic )= 0;
};
Methods
SLE_ReportRequestType Get_ReportRequestType() const;
Returns the type of request (immediate, periodically, stop).
void Set_ReportRequestType( SLE_ReportRequestType type );
Sets the type of request.
SLE_ReportingCycle Get_ReportingCycle() const;
Returns the reporting cycle value currently set in the object.
Precondition: The report request type is set to ‘periodically’.
void Set_ReportingCycle( SLE_ReportingCycle cycle );
Sets the reporting cycle to the value passed as argument.
Precondition: The report request type is set to ‘periodically’.
SLE_ScheduleStatusReportDiagnostic Get_SSRDiagnostic() const;
Returns the diagnostic code if set in the object.
void Set_SSRDiagnostic( SLE_ScheduleStatusReportDiagnostic diagnostic );
Sets the diagnostic code to the value of the argument, the diagnostic type to ‘specific’, and the result to ‘negative’.
Default Setting of Operation Parameters after Creation
Argument
|
Created directly
|
Created by Service Instance
|
report request type
|
‘invalid’
|
‘invalid’
|
reporting cycle
|
zero
|
zero
|
schedule status report diagnostic
|
‘invalid’
|
‘invalid’
|
Checking of Invocation Parameters
Argument
|
Required condition
|
report request type
|
must not be ‘invalid’
|
reporting cycle
|
must be set if the reporting type is periodically; if used the value must be in the range 2 to 600 seconds
|
Checking of Return Parameters
Argument
|
Required condition
|
schedule status report diagnostic
|
if the diagnostic type is ‘specific’ must not be ‘invalid’
|
Share with your friends: |