Recommendation for Space Data System Practices
Download 2.26 Mb.
|
- Navigate this page:
- Methods HRESULT CreateOperation( const GUID iid, SLE_OpType optype, void** ppv );
- SLE API Application Interfaces SLE Service Interface Name
- Methods HRESULT InformOpInvoke( ISLE_Operation* poperation, unsigned long seqCount = 0 );
- HRESULT InformOpReturn( ISLE_ConfirmedOperation* poperation, unsigned long seqCount = 0 );
- HRESULT ProtocolAbort( const SLE_Octet* diagnostic, size_t size );
- Reporting Interface Name
- Methods void LogRecord( SLE_Component component, const ISLE_SII* sii, SLE_LogMessageType type, unsigned long messageId, const char* message );
- Tracing Interface Name
- Methods void TraceRecord( SLE_TraceLevel level, SLE_Component component, ISLE_SII* psii, const char* text );
- Time Source Interface Name
- Methods SLE_Octet* Get_CurrentTime() const;
- Figure B 1919: Structure of Result Codes
- Success Codes adopted from the COM Facility NULL
- Error Codes adopted from the COM Facility NULL
- Success Codes defined by this Recommended Practice (Facility ITF)
- Error Codes defined by this Recommended Practice (Facility ITF)
- Structure of the Service Instance Identifier for Version 1 of the SLE Services RAF, RCF, and CLTU (Normative)
Synopsis #include #include interface ISLE_Operation; #define IID_ISLE_SIOpFactory_DEF { 0x24396fc5, 0xcd99, 0x11d2, \ { 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } } interface ISLE_SIOpFactory : IUnknown { virtual HRESULT CreateOperation( const GUID& iid, SLE_OpType optype, void** ppv ) const = 0; };
HRESULT CreateOperation( const GUID& iid, SLE_OpType optype, void** ppv ); Creates and configures a new operation object as specified by the argument. If the interface cannot be found, does not refer to an operation object interface, or is not supported for the service type or role, returns an error. Arguments iid GUID for the interface to be returned optype type of the operation object to be created ppv pointer to the requested interface of the operation object Result codes S_OK the operation object has been created and configured SLE_E_STATE the service instance has not been configured SLE_E_TYPE the operation is not supported by the service type or for the role of the service instance (e.g., a RAF Service User application cannot create a TRANSFER-DATA operation) E_NOINTERFACE the interface is not supported by an operation object of the specified type
Name ISLE_ServiceInform GUID {24396FC6-CD99-11d2-9B44-00A0246D80DB} Inheritance: IUnknown File ISLE_ServiceInform.H The interface allows passing of operation invocations and returns to the SLE Application for a single service instance. The client of this interface is expected to have checked all PDUs that pass this interface to the level defined for the API Service Element in 3.3.5.1.2. For data transfer for forward services and for the complete online and offline return services, the interface additionally provides the means to signal to the application that data transfer may continue. Suspension of data transfer is requested via the complementary interface ISLE_ServiceInitiate. Finally the interface provides a means to inform the application when a protocol abort occurs and when the scheduled provision period of the service instance ends. Synopsis #include #include interface ISLE_Operation; interface ISLE_ConfirmedOperation;
{ 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } } interface ISLE_ServiceInform : IUnknown { virtual HRESULT InformOpInvoke( ISLE_Operation* poperation, unsigned long seqCount = 0 ) = 0; virtual HRESULT InformOpReturn( ISLE_ConfirmedOperation* poperation, unsigned long seqCount = 0 ) = 0; virtual void ResumeDataTransfer() = 0; virtual void ProvisionPeriodEnds() = 0; virtual HRESULT ProtocolAbort( const SLE_Octet* diagnostic, size_t size ) = 0; };
Accepts an operation invocation. If the operation is confirmed, it shall be passed back to the service instance via the complementary interface when the return is sent. Arguments poperation the operation object containing the invocation seqCount sequence count for PDUs as defined in 3.7.3 Result codes S_OK the invocation has been accepted SLE_E_SEQUENCE sequence count out of acceptable window E_FAIL further unspecified error HRESULT InformOpReturn( ISLE_ConfirmedOperation* poperation, unsigned long seqCount = 0 ); Accepts an operation return. Arguments poperation the operation object containing the return seqCount sequence count for PDUs as defined in 3.7.3 Result codes S_OK the invocation has been accepted SLE_E_SEQUENCE sequence count out of acceptable window E_FAIL further unspecified error void ResumeDataTransfer(); Informs the application that a previously suspended data transfer activity can be resumed. void ProvisionPeriodEnds(); Informs the application that the scheduled provision period for the service instance ends and the service instance can be deleted. HRESULT ProtocolAbort( const SLE_Octet* diagnostic, size_t size ); Reports failure of the communications system for the association. Arguments diagnostic diagnostic data as provided by the data communication service size size of the diagnostic data in bytes Result codes S_OK accepted E_UNEXPECTED the application is not aware of an active association
Name ISLE_Reporter GUID {24396FC7-CD99-11d2-9B44-00A0246D80DB} Inheritance: IUnknown File ISLE_Reported.H The interface is passed to all API components and is used to enter messages into the system log and to notify the application of specific alarms. The types of alarms, which can be passed to this interface, are defined in . An alarm is complemented by a brief 20-character text that can be used for display. The methods in this interface do not report the time of an event. It is expected that the time is added by the implementation of the interface.
#include #include interface ISLE_SII; #define IID_ISLE_Reporter_DEF { 0x24396fc7, 0xcd99, 0x11d2, \ { 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } } interface ISLE_Reporter : IUnknown { virtual void LogRecord( SLE_Component component, const ISLE_SII* sii, SLE_LogMessageType type, unsigned long messageId, const char* message ) = 0; virtual void Notify( SLE_Alarm alarm, SLE_Component component, const ISLE_SII* sii, unsigned long messageId, const char* message = 0 ) = 0; };
void LogRecord( SLE_Component component, const ISLE_SII* sii, SLE_LogMessageType type, unsigned long messageId, const char* message ); Enters a message into the system log. Arguments component the component that issues the log message sii the service instance identifier associated with the log message or a NULL pointer if the message is not associated with a particular service instance type the type of the log message (alarm or information message) messageId the numeric identifier of the message message an ASCII string without formatting characters void Notify( SLE_Alarm alarm, SLE_Component component, const ISLE_SII* sii, unsigned long messageId, const char* message ); Notifies the application of a specific event. Arguments alarm the alarm that is notified component the components generating the notification sii the service instance identifier associated with the notification or a NULL pointer if the notification is not associated with a particular service instance messageId the numeric identifier of the message text an optional ASCII string of max 20 characters without formatting characters; if no text is supplied the argument must be set to NULL
Name ISLE_Trace GUID {24396FC8-CD99-11d2-9B44-00A0246D80DB} Inheritance: IUnknown File ISLE_Trace.H The interface is provided to API components to enter trace records, when tracing is started via the interface ISLE_TraceControl. The trace method in this interface does not report the time of an event. It is expected that the time is added by the implementation of the interface.
#include #include interface ISLE_SII; #define IID_ISLE_Trace_DEF { 0x24396fc8, 0xcd99, 0x11d2, \ { 0x9b, 0x44, 0x0, 0xa0, 0x24, 0x6d, 0x80, 0xdb } } interface ISLE_Trace : IUnknown { virtual void TraceRecord( SLE_TraceLevel level, SLE_Component component, ISLE_SII* psii, const char* text ) = 0; };
Enters a trace record. Arguments level the trace level at which the record is generated component the component that issues the trace record psii the service instance identifier associated with the trace record or a NULL pointer if the record is not associated with a particular service instance text an ASCII string with the trace information
Name ISLE_TimeSource GUID {390d3508-6c7c-11d3-a297-80954a16aa77} Inheritance: IUnknown File ISLE_TimeSource.H The interface is provided to the API component ‘SLE Utilities’ by applications wishing to provide a time source to the API. If provided, the component obtains current time from this interface. Other API components will obtain this time via the utility interface ISLE_Time. For the purpose of implementing timers, API components can assume that the time provided by this interface has a constant offset to system time within the limits of the timer accuracy required by this specification.
#include #include { 0xa2, 0x97, 0x80, 0x95, 0x4a, 0x16, 0xaa, 0x77 } } interface ISLE_TimeSource : IUnknown { virtual SLE_Octet* Get_CurrentTime() const = 0; };
SLE_Octet* Get_CurrentTime() const; Returns the current time in CCSDS CDS format.
For the result codes returned by methods in SLE API interfaces this Recommended Practice adopts the scheme defined by the COM Specification (see annex A.1.48.1.1.1.1.2). The general COM result code HRESULT is a 32 bit integer, structured as shown in figure B -19. Figure B 1919: Structure of Result Codes The fields in this structure are: S Severity field (1 bit) 0 Success 1 Error
R Reserved (2 bits, must be set to zero) Facility indicates a group of codes Code the individual code within a facility COM specifies a number of general codes in the COM Facility NULL (facility code 0), of which a subset is adopted for the SLE API. In order to ensure, that the SLE API can also be implemented in a COM environment, specific codes defined by this Recommended Practice are allocated to the COM Facility ITF (facility code 4), which is foreseen for interface specific result codes. In addition, all specific codes are located above HEX 0200 to avoid conflicts with codes allocated by COM. Following COM conventions, the mnemonics for the result codes are defined as
Where NOTE – If The result codes adopted from the COM Facility NULL and the result codes defined by this Recommended Practice are available in the file SLE_Result.H. This file also defines the following useful macros also adopted from COM: SUCCEEDED(result) returns true if the severity is ‘success’ FAILED(result) returns true if the severity is ‘error’ HRESULT_CODE(result) returns the value of the code field HRESULT_FACILITY(result) returns the value of the facility field HRESULT_SEVERITY(result) returns the value of the severity field MAKE_HRESULT(sev,fac,code) constructs a HRESULT variable The result codes returned by functions of the SLE API are defined in annex A.1.1.1.1.1.1.1 of this Recommended Practice and it is expected that implementations do not return any other code than specified there, except for the following, that can always be returned by a function: E_FAIL indicating an unspecified error E_UNEXPECTED indicating a catastrophic failure, which is expected to originate from a serious software problem In spite of this general rule, experience shows that not all cases can be tested and clients should expect functions to return other codes and process them as a general error indication. This Recommended Practice reserves the codes HEX 0200 through HEX 03FF for use by the SLE API Recommended Standard and its supplemental Recommended Practice documents for service-specific APIs. It is recommended that implementations of this Recommended Practice allocate additional result codes in the range HEX 0400 through HEX 05FF, leaving the codes HEX 0600 and above for use by SLE applications.
Directory: sec -> docs -> 201510 Documents for SC13 Submission sec -> Security Education Narrative Database Patterns of Professional Education sec -> Guidelines for implementation of Prime Minister’s New 15 Point Programme for the Welfare of Minorities sec -> Morphodynamics of a Constructed Marsh: Project Greenshores, Pensacola, Florida sec -> Registration 6: 00pm – 6: 10pm Welcome/Opening Remarks sec -> ¡bienvenidos! Welcome to Puerto Rico! 2 Things to know immediately upon arrival 2 sec -> Cadillac Racing cts-v coupe Media Kit sec -> Sure Bet Narrative Nonfiction Suggestions sec -> Executive Board of the United Nations Development Programme, the United Nations Population Fund and the United Nations Office for Project Services 201510 Documents for SC13 Submission -> Recommendation for Space Data System Practices Download 2.26 Mb. Share with your friends:
|
