Document Outline

• Cover
• Notes regarding these materials
• Preface
• Contents
• Section 1 Overview
  • 1.1 Overview
  • 1.2 Operating Environment
• Section 2 Installation
  • 2.1 Downloading
  • 2.2 Installing RPCGEN
• Section 3 Functions and Files Generated by RPCGEN
  • 3.1 Functions Generated by RPCGEN
    • 3.1.1 Client
    • 3.1.2 Server
  • 3.2 Files Generated by RPCGEN
• Section 4 Executing RPCGEN
  • 4.1 Executing RPCGEN
  • 4.2 Options
    • 4.2.1 PUBI
    • 4.2.2 CLNTS
    • 4.2.3 CLNTI
    • 4.2.4 SVRS
    • 4.2.5 SVRI
  • 4.3 Executing RPCGEN as a Build Phase in the High-performance Embedded Workshop
• Section 5 Specifications of a Config File
  • 5.1 Definition
  • 5.2 Comments
  • 5.3 File Locations
    • 5.3.1 PUB_INCPATH
    • 5.3.2 CLNT_SOURCEPATH
    • 5.3.3 CLNT_INCPATH
    • 5.3.4 SVR_SOURCEPATH
    • 5.3.5 SVR_INCPATH
  • 5.4 Controlling the Output of #include Directives
    • 5.4.1 Order of #Include Directives
    • 5.4.2 GLOBAL_INCFILE
    • 5.4.3 CLNT_INCFILE
    • 5.4.4 SVR_INCFILE
  • 5.5 Server Information
    • 5.5.1 SVR_NAME
    • 5.5.2 SVR_ID
    • 5.5.3 SVR_VERSION
    • 5.5.4 SVR_NOINIT
    • 5.5.5 SVR_NOSTUBTBL
    • 5.5.6 SVR_NOSHUTDOWN
    • 5.5.7 SVR_STATIC
    • 5.5.8 SVR_AUTH
    • 5.5.9 SVR_SECTION
  • 5.6 Client Information
    • 5.6.1 CLNT_NOINIT
    • 5.6.2 CLNT_NOSHUTDOWN
    • 5.6.3 CLNT_CALLCHK
    • 5.6.4 CLNT_SECTION
  • 5.7 Server Functions
    • 5.7.1 RPC_FUNC
• Section 6 Definitions of Server Functions
  • 6.1 Format
  • 6.2 Function-Type Directives
    • 6.2.1 Function with a Return Value
    • 6.2.2 Function without a Return Value
    • 6.2.3 When the Return Value is not Representable as a 4-Byte Integer
  • 6.3 Function Names
  • 6.4 Parameters
  • 6.5 Keywords for Input/Output
    • 6.5.1 IN (Input)
    • 6.5.2 OUT (Output)
    • 6.5.3 INOUT (Input and Output)
    • 6.5.4 REF (Passing by Reference)
    • 6.5.5 DESC (Specified Parameter is not Passed from the Client to the Server)
  • 6.6 Keywords for Data Types
    • 6.6.1 DFLT (Default)
    • 6.6.2 STR (String)
    • 6.6.3 PTR (Pointer)
    • 6.6.4 ARY (Array)
    • 6.6.5 COUNT (Number of Elements in an Array)
  • 6.7 Optional Keywords
    • 6.7.1 SVRSTUB (Server Stub)
    • 6.7.2 SVRFUNC (Server Function Name)
    • 6.7.3 CLNTSTUB (Client Stub)
    • 6.7.4 UNACK (Asynchronous Call)
    • 6.7.5 CLNTCOPYCBK (RPC Call by rpc_call_copycbk())
• Section 7 Server Functions Not Supported by RPCGEN
  • 7.1 Parameter
  • 7.2 Return Value
• Section 8 Application Interface
  • 8.1 Client-Stub Functions Generated by RPCGEN
  • 8.2 Server-Stub Functions Generated by RPCGEN
  • 8.3 Server-Initialization Function
  • 8.4 Server-Stub Function Table
  • 8.5 Server-Shutdown Function
  • 8.6 Client-Initialization Function
  • 8.7 Client-Shutdown Function
  • 8.8 rpc_retval_adr()
  • 8.9 <Config file>_public.h
  • 8.10 Local Variables Used in the Source Code Created by RPCGEN
• Section 9 Notes
• Section 10 Error Messages
  • 10.1 Format
  • 10.2 General
  • 10.3 Definition Errors (other than RPC_FUNC)
  • 10.4 Definition Errors (RPC_FUNC)
• Section 11 Samples
  • 11.1 Config File (sample.x)
  • 11.2 sample_clnt.h
  • 11.3 sample_private.h
  • 11.4 sample_clnt.c
  • 11.5 sample_svr.h
  • 11.6 sample_svr.c
  • 11.7 sample_public.h
• Colophon