Skip to content

interfaces.md

Latest commit

 

History

History
112 lines (96 loc) · 3.64 KB

interfaces.md

File metadata and controls

112 lines (96 loc) · 3.64 KB

Back to home.

Interface Specification Template

1. General Information

  • Interface Name: A unique identifier for the interface.
  • Component A: The component providing the interface.
  • Component B: The component consuming the interface.
  • Interface Type: Shared Memory, Function Calls, or Named Pipes.
  • Description: A brief overview of the interface and its purpose.

2. Interface Details

2.1 Shared Memory

  • Memory Segment: Name or identifier of the shared memory segment.
  • Access Mode: Read/Write permissions for each component.
  • Data Structure: Definition of the data structure being shared (e.g., structs, arrays).
  • Synchronization Mechanism: Method for synchronizing access (e.g., mutexes, semaphores).
  • Example: Pseudo code demonstrating how to access the shared memory.

2.2 Function Calls

  • Function Signature: Definition of the function, including parameters and return type.
  • Parameter Details: Description of each parameter (type, purpose, constraints).
  • Return Value: Description of the return value (type, purpose).
  • Error Handling: Possible error codes or exceptions and their meanings.
  • Example: Pseudo code demonstrating a function call.

2.3 Named Pipes

  • Pipe Name: Name or identifier of the named pipe.
  • Access Mode: Read/Write permissions for each component.
  • Data Format: Definition of the data format being transmitted (e.g., JSON, XML).
  • Communication Protocol: Method for initiating and terminating communication (e.g., handshaking).
  • Example: Pseudo code demonstrating communication via the named pipe.

3. Interface Diagram

  • Diagram: A visual representation showing how Component A and Component B interact through the interface.

Example Specification

General Information

  • Interface Name: DataSyncInterface
  • Component A: DataCollector
  • Component B: DataProcessor
  • Interface Type: Shared Memory
  • Description: This interface allows DataCollector to share collected data with DataProcessor in real-time.

Interface Details

Shared Memory

  • Memory Segment: DataSegment
  • Access Mode: DataCollector (Write), DataProcessor (Read)
  • Data Structure: 
    struct DataRecord {
    int id;
    float value;
    char timestamp[20];
}
  • Synchronization Mechanism: Mutex DataMutex
  • Example: 
    // DataCollector
lock(DataMutex)
DataSegment.write(DataRecord)
unlock(DataMutex)

// DataProcessor
lock(DataMutex)
record = DataSegment.read()
unlock(DataMutex)

Function Calls

  • Function Signature: DataRecord getData(int recordId)
  • Parameter Details:
    • recordId: integer, the ID of the data record to retrieve.
  • Return Value: DataRecord
  • Error Handling: Returns NULL if recordId is not found.
  • Example: 
    DataRecord record = getData(123)
if record is NULL
    // handle error

Named Pipes

  • Pipe Name: DataPipe
  • Access Mode: DataCollector (Write), DataProcessor (Read)
  • Data Format: JSON
  • Communication Protocol: Handshake before sending data, close pipe after transmission.
  • Example: 
    // DataCollector
open(DataPipe, Write)
send(JSON.stringify(DataRecord))
close(DataPipe)

// DataProcessor
open(DataPipe, Read)
data = receive()
DataRecord record = JSON.parse(data)
close(DataPipe)

Interface Diagram

+---------------+                  +----------------+
| DataCollector | -- DataSegment --| DataProcessor  |
|               |                  |                |
+---------------+                  +----------------+