Broker help/TOC

From VistApedia
Revision as of 22:23, 20 December 2010 by DavidWhitten (talk | contribs)
Jump to: navigation, search

This is a conversion of the Broker.hlp file to mediawiki format using the helpdeco converter program converted to vistapedia.net by Ignacio Valdes of Astronaut, LLC The original formatting such as Table of Contents linking and screen shots is not present.

Base broker.hlp>main
Title RPC Broker Developer's Guide

Contents

RPC Broker V. 1.1 Developer's Guide

Overview

Introduction

Broker Overview

Orientation

About this Version of the RPC Broker

What's New in the BDK

Developer Considerations

Application Issues

Silent Login

Context-sensitive Help for the TRPCBroker Component

RPC Broker Components and Classes

TRPCBroker Component

TXWBRichEdit Component

TMult Class

TParamRecord Class

TParams Class

TVistaLogin Class

TVistaUser Class

Broker_help\3 EBrokerError Exception=EBrokerError

Units

Broker_help\4 Hash Unit=Hash_unit

Broker_help\4 LoginFrm Unit=LoginFrm_Unit

Broker_help\4 MFunStr Unit=MFunStr_unit

Broker_help\4 RPCConf1 Unit=RPCConf1_unit

Broker_help\4 RpcSLogin Unit=RpcSLogin_Unit

Broker_help\4 SplVista Unit=SplVista_unit

Broker_help\4 TRPCB Unit=TRPCB_unit

Broker_help\4 TVCEdit Unit=TVCEdit_Unit

Broker_help\2 Remote Procedure Calls (RPCs)

Broker_help\3 Overview=rpc_overview

Broker_help\3 What Makes a Good RPC?=rpc_good

Broker_help\3 Creating RPCs=rpc_create

===[[Broker_help\3 Using an Existing M API=Using_an_Existing_M_API

Broker_help\3 M Entry Point for an RPC

Broker_help\4 Relationship Between an M Entry Point and an RPC=rpc_routine_relationship

Broker_help\4 First Input Parameter=rpc_first_input_param

Broker_help\4 Return Value Types=rpc_return_value_types

Broker_help\4 Input Parameters=rpc_input_parameter_types

Broker_help\4 Examples=rpc_entry_point_examples

Broker_help\3 RPC Entry in the Remote Procedure File

Broker_help\4 RPC Entry in the Remote Procedure File=rpc_file_entry

Broker_help\4 RPC Version in the Remote Procedure File=RPC_Version_in_Remote_Procedure_File

Broker_help\4 Blocking an RPC in the Remote Procedure File=Blocking_an_RPC

Broker_help\4 Cleanup after RPC Execution=rpc_cleanup

Broker_help\4 Documenting RPCs=rpc_document

Broker_help\3 Executing RPCs from Clients =

Broker_help\4 How to Execute an RPC from a Client=rpc_execute_from_client

Broker_help\4 RPC Security: How to Register an RPC=rpc_register

Broker_help\4 RPC Limits=RPC_limits

Broker_help\4 BrokerExample Online Code Example=BrokerExample

Other RPC Broker APIs

Overview

Encryption Functions

GetServerInfo Function

M Emulation Functions

VistA Splash Screen Procedures =

$$BROKER^XWBLIB

$$RTRNFMT^XWBLIB

XWB ARE RPCS AVAILABLE

XWB IS RPC AVAILABLE

XWB GET VARIABLE VALUE RPC

Running RPCs on a Remote Server

Options For Running RPCs on a Remote Server

Checking RPC Availability on a Remote Server

XWB DIRECT RPC

XWB REMOTE RPC

XWB REMOTE STATUS CHECK

XWB REMOTE GETDATA

XWB REMOTE CLEAR

Deferred RPCs

Overview of Deferred RPCs

XWB DEFERRED RPC

XWB DEFERRED STATUS

XWB DEFERRED GETDATA

XWB DEFERRED CLEAR

XWB DEFERRED CLEARALL

Debugging and Troubleshooting

Overview

How to Debug Your Application

RPC Error Trapping

Identifying the Listener Process on the Server

Identifying the Handler Process on the Server

Testing Your RPC Broker Connection

Client Timeout and Buffer Clearing

Memory Leaks

Developer Utilities

RPC Broker Programmer Preferences

Tutorial

Introduction

Advanced Preparation

Step 1: Create Application with an RPC Broker Component

Step 2: Get Server/Port

Step 3: Establish Broker Connection =

Step 4: RPC Routine to List Terminal Types

Step 5: RPC to List Terminal Types

Step 6: Call the ZxxxTT LIST RPC

Step 7: Associate IENs

Step 8: Routine to Retrieve Terminal Types

Step 9: RPC to Retrieve Terminal Types

Step 10: Call Zxxx RETRIEVE RPC

Step 11: Register RPCs

See Also: FileMan Delphi Components (FMDC)

Tutorial Source Code

DLL Interface

Introduction

DLL Special Issues =

RPC Results from DLL Calls

GetServerInfo Function and the DLL

DLL Exported Functions

RPCBCall

RPCBCreate

RPCBCreateContext

RPCBFree

RPCBMultItemGet

RPCBMultPropGet

RPCBMultSet

RPCBMultSortedSet

RPCBParamGet

RPCBParamSet

RPCBPropGet

RPCBPropSet

Guidelines for C++

Overview

TRPCBroker C++ Class Methods

Initialize the Class

Create Broker Instances

Connect to the Server

Execute RPCs

Destroy Broker Instances

Guidelines for C

Overview

Initialize—LoadLibrary and GetProcAddress

Create Broker Components

Connect to the Server

Execute RPCs

Destroy Broker Components

Guidelines for Visual Basic

Overview

Initialize

Create Broker Components

Connect to the Server

Execute RPCs

Destroy Broker Components