Target Communication Framework Services

Copyright (c) 2007 Wind River Systems, Inc. Made available under the EPL v1.0

Direct comments, questions to the dsdp-tm-dev@eclipse.org mailing list

Table of Contents

Overview

TCF communication model is based on the idea of services. A service is a group of related commands, events and semantics. For example, Memory Service defines group of command and events for reading and writing target memory. Service definitions are not part of the framework specification, and new services are expected to be defined by developers of tools and target agents. Defenitions of standard services are provided to achieve certain level of compatibility between tools and targets.

Syntax Rules Notation

Format of the protocol messages is defined by syntax rules. Syntax is described using a simple variant of Backus-Naur Form. In particular:


<chars>
     <char>
     <chars> <char>

Error Report Format

Most of TCF standard services use same format for error reporting:


<error report>
     <int: error code>  <error description>

Error code zero means success. Error description provides a short, localizable, human readable explanation of error.


<error description>
     null
     <string>
     { "format" : <string> , "params" : [ <params> ] }
  
<params>
     <value>
     <params> , <value>

For <string> and <value> encoding see JSON - Preferred Marshaling. Error description format supports separation between constant and variable parts of the message ("format" and "params"). This is done to support localization. See Java class java.text.MessageFormat for details.

Services