Files
DP44/docs/ai/Common/DTS.CommonCore/Enums/Communication.md
2026-04-17 14:55:32 -04:00

2.0 KiB

source_files, generated_at, model, schema_version, sha256
source_files generated_at model schema_version sha256
Common/DTS.CommonCore/Enums/Communication/CommunicationConstantsAndEnums.cs
2026-04-17T16:09:21.372435+00:00 zai-org/GLM-5-FP8 1 d613cb9c5eb24602

Communication

Purpose

This module defines communication operation outcomes and a callback contract for reporting communication status. It provides a standardized enumeration for tracking the success, failure, or timeout states of connect, disconnect, send, and receive operations, enabling consistent error handling and status reporting across the communication layer.

Public Interface

CommunicationConstantsAndEnums (static class)

  • Contains all communication-related enums and delegates.

CommunicationResult (enum)

  • ConnectOK - Connection succeeded
  • ConnectFailed - Connection attempt failed
  • ConnectTimeout - Connection attempt timed out
  • DisconnectOK - Disconnection succeeded
  • DisconnectFailed - Disconnection attempt failed
  • DisconnectTimeout - Disconnection attempt timed out
  • SendOK - Send operation succeeded
  • SendFailed - Send operation failed
  • SendTimeout - Send operation timed out
  • ReceiveOK - Receive operation succeeded
  • ReceiveFailed - Receive operation failed
  • ReceiveTimeout - Receive operation timed out
  • Canceled - Operation was canceled

CommunicationCallback (delegate)

  • Signature: delegate bool CommunicationCallback(ICommunicationReport report)
  • Accepts an ICommunicationReport instance and returns a boolean result.

Invariants

  • The CommunicationResult enum values are implicitly ordered as defined; no explicit integer values are assigned.
  • Each operation type (Connect, Disconnect, Send, Receive) has exactly three outcome variants: OK, Failed, and Timeout, plus a global Canceled state.

Dependencies

  • Depends on: DTS.Common.Interface.Communication.ICommunicationReport (used in delegate signature)
  • Depended on by: Not determinable from source alone

Gotchas

  • None identified from source alone.