HP Advanced Communications Controllers (ACC) manual Ltqdget

Page 153

 

 

ZCOM C I/F Library Routines

 

 

LTQDGET (3X)

PARAMETERS

 

 

zap

ZCOM address of a terminal from which to get

 

the data.

queue

Terminal data queue number (specifies which

 

data queue is to be used).

 

0

- Sub-packet holding queue (reserved)

 

1

- Data holding queue A

 

2

- Data holding queue B

 

3

- Data holding queue C

 

4

- Data holding queue D

ibuf (Return Param)

On a successful return, the data is placed into

 

this buffer.

len

Length in bytes of ibuf.

rlenp (Return

Actual number of bytes returned in ibuf.

Param)

 

 

NOTES

Normally, the data queue number used should be allocated by ZMON

 

(see the zltqueue man page for how to get a data queue number). There is

 

no queue ownership validation within this routine; it is up to the user to

 

make sure that the queue usage is valid and consistent.

RETURN VALUE

Routine ltqdget returns 0 if successful. Otherwise, a non-zeroerror code

 

is returned. See /opt/acc/include/zcom/zcomsys.h for the list of ZCOM

 

error codes and their meanings.

 

If the specified queue is empty, then the ZENODATA error (-24) is

 

returned and ibuf contains invalid data.

EXAMPLE

#include

<zcom/zcomsys.h>

 

#include

<zcom/zcomcall.h>

 

int32

ierr;

 

zaddr_type

zaddr;

 

uint32

queue;

 

char

ibuf[size]; /*Where size is user-determined; must be

 

>= len */

 

 

int32

len;

 

int32

rlen;

if (ierr = ltqdget (&zaddr, queue, ibuf, len, &rlen)) {

Chapter 4

153

Image 153
Contents ACC Programmer’s Reference Guide Page Legal Notices Page First Edition February 2004 Release Printing HistorySoftware Manuals Related DocumentationContents Zcom C I/F Library Routines Contents Contents Zcom Subsystem Introduction Zcom Software Overview Overview of Zcom Software Structure Zcom Subsystem Components Zcom Software Overview Zcom Concepts Definition and Features of ZLUs Program ZLUs Zcom Concepts User Interface References Zcom Message Handling Overview ZLU Definition Mapped ZLUs Program Message Queueing Message QueuingPhysical Terminal Table Priorities Multiplexing Outbound Multiplexing Inbound Multiplexing PTZRVR=PZLU Inbound MultiplexingTerminal State Terminal StateError Handling Error Handling Chapter Zcom Tables and Data Zcom Tables and Data Structures Memory Organization Memory OrganizationDifferences in 32-bit and 64-bit Data Structures ACC Zcom product to implement its functionality. These data Zcom Header Structure Zcom Header StructureField Name Field Description Field Type Size Bytes Hnresp HncardHnltql HnltslHndsig HndpidHnidle HnhighZcom Header Structure Zcom Header Structure Zcom Header Structure Zcom Header Structure Zcom Header Structure Ttgen Zcom Header Structure Qlbgrp Queue Label TableQlbnam QlbqnbStorage Label Table Zcom Header Structure Node Entries Table Node Entries TableFLAGS.event Stats Data StructureFLAGS.valid FLAGS.statusHost Link Information Structure Node Entries Table Individual ZLU Data Structure zlutype ZLU TablesType Description ZLU Type ValuesZLU Tables Logical Terminal Tables Logical Terminal Table Reserved AreaField Name Field Description Size Type Bytes Logical Terminal Table User Maintainable Area SPARE2 10 Logical Terminal Table User Maintainable AreaSystem Status flags Logical Terminal Tables LTCWCT, LTTXCT, LTRXCT, Lterct Message and error counters Logical Status Format LtstatLTINST, LTBRCH, LTWORK, Ltarea Terminal logical ID Physical Terminal Tables System Area Physical Terminal TablesPhysical Terminal Tables User Maintainable Area Ptuser Physical Terminal Tables Physical Terminal Tables Physical Terminal Tables Terminal Status Field Ptdrst Physical Terminal Tables Physical Terminal Tables Interface Table Interface TableImaxterms Iportn 63-32 31-2 27-18 17-1 13-12 10-6 Interface HPA Value Format InhpaInterface Card Status Ifstat Symbol Value hex MeaningScheduler Event Flags Ischdl Interface Table Interface Table CARD.MMP Structure CARD.BSP Structure Interface Table Tmtail Itxlstx Express Transmit List HeadersInterface Table Zcomipstattxbx Port Configuration Buffer Iportn 20 4-Channel E1/T1 ACC Card Format 31-30 29-26 26-22 21-20 19-16 15-11 10-0Fmode Timeslot Array Element Structure Port Subchannel Configuration Structure31-30 29-24 23-8 23 Subchannel Specification Array Element StructureItbs INVInterface Table Optional E1/T1 Tunable Parameters Bquota Response Record Format Response RecordsResponse Type Field Symbol Value MeaningZcomrptypebuffer Zcomrptyperemote100 Free Queue Header Structure zfqhtype Queue HeaderQlimit Queue Header Structure zqhdtypeQfdata QfuncChapter 103 Queue Flag Format Symbol Value Meaning HexChapter 105 Organization of Buffer Pool Data Buffer PoolChapter 107 Buffer Pool Layout when first initialized System flags length & status Uns.int Linkage to the next buffer. zbhdtype. See -30 and TableReserved, not used Int Pointer to next buffer on queueFlag 32 Buffer flags Bfflag Field FormatChapter 111 Message Header zmhdtype Message HeaderMID MRQMessage ID Header zmidtype Message Type Mstype 37 Response code for all other message types Response code for message type 2 and 10 FormatLPR XPS PGW BFR DEF ERR LPRMessage Request Header zmrqtype Request Value Description Mrqcode Terminal request codes118 System Event Message zeventtype Structure Nodenum Node Status Change Event Fields ZcomsetypenodeNstat SpareDynamic Reconfiguration Event CfgclassCFGINFO1 Change in Card Status Event Zcomsetypecard Chapter 123 HPA Table Entries Zcom Kernel DataHPA value of this interface Long Reserved for future use IntChapter 125 HPA value of I/F card Hpano Chapter 127 SYS structure Zcom system global information Current Zcom system status Current Zcom system status Higher Order BitsName Value hex State Debug Level Field Format Debug Level Field ValuesBit Name Value Meaning Hex Chapter 131 132 Zcglock Linfo Structure FieldsZcmlock ZcrlockSuper IFT spinlock Zcslock Data Structure LockpRefcount Zcom C I/F Library Routines 136 Initialization call Zinit Zcom library access initializationInterface configuration calls Zsend Send data buffer to ZLU ZLU information callsZLU Definition Man Pages Cancellation point GetdeviceFork unsafe Chapter 143 Pointer to a data structure containing the full Allocated memory when it is no longer neededDevice table. The device table is an array Zdevtype elementsMultiprotocol ACC Utilities Reference Device file, /opt/acc/cfg/zcomdeviceZdgen1, malloc3C Opt/acc/cfg/zcomdevice.txtLtfind Laddr ZapLlen Ibuf Return ParamChapter 149 150 Ltqdget 152 Ltqdget 154 Ltqdput 156 Ltqdput Zcom error codes and their meanings158 Makezluname Returned Comment NameMYZLU01 Be returned Parameter and from the same TTY, the same ZLU name will beChapter 161 Ptfind Chapter 163 Async-signal unsafe Async-cancel unsafePhysical terminal table data will be placed Pointer to a buffer into which the ZcomIerr != 0, then no data is moved into zptt Len Length in bytes of zptt buffer166 Chapter 167 Zclos Zclos Zcntl Zmoderpterrs ZmodenowaitZmodedefstatus ZmoderpterrswbufMulti-protocol ACC Programmers’ Reference Guide MhpReturn RstatParam Rtyp174 Chapter 175 176 Chapter 177 Zcomerror Not a cancellationPoint Err Error number Found, it uses the default message file default.msgFile zerrmsg.msg in /opt/acc/msg ZCOMMESSAGEPATH. If not 180 Zcomlname Async-cancel safeZcomlog3x Zcomlog 184 Zcomatchar ZcomatzerrorZcomatuchar Zcomatsint186 Chapter 187 ACC Programmers Reference Guide under ‘ZCOM Status Message ZcomstatusChapter 189 Zconfig Node Destination node Cdata RdataReturn Param Response data Chapter 193 Zcomzconfigsys ZcomzconfigcntlZcomzconfigcard ZcomzconfigportDSC Control ZcomsetypereconfigHeader.tag1 Header.tag2 Any values Configuration Data header.configNo specific response data or error Header.configData.setctl.cfgclass Header.tag1 Header.tag2 Data.sysret.errorData.setsys.sysname Data.setsys.qlimitChapter 199 Header.tag1 Header.tag2 Any values Data.setcard.iftno Link an interface to different hardwareData.setcard.itype Data.setcard.fnameData.cardret.iftno Data.cardret.errorData.setport.portno Data.setport.rcodeData.setport.spare Value Operating mode Value Sync mode selectData.setport.cnfg Value Encoding modesNo Parity Parity selectOdd parity Even parity0001 300 Value Port modeValue Rate 0000 150Fmod Frame mode parameterValue Port mode 0000 Reserved Value Other port for clock synchronization PortValue T1 Transmit Attenuation Z7330B only 15 dB 22.5 dB Fast link-down option Otherwise by default there is a delay to avoidMakes the line go down whenever loss of T1/E1 Frame synchronization is detected by the FalcJT G.706 mode Z7330B only Long-haul mode Z7330B onlyT1/ESF performance report messages suppressed Reduced corner frequency Z7330B onlyData.portret.status Data.portret.iftno Data.portret.portnoChapter 211 212 Header.action Configuration DataData.setportsc.iftno Data.setportsc.portnoReceive subch number Receive fill mask Transmit subch number Transmit fill mask Set toChapter 215 Data.setportsc.ptcfg-ptinfo.subchb.spec Set to ModeData.setportsc.len Data.setportsc.qlimitData.portscret.status 218 Chapter 219 220 Data.setterm.daddr Data.setterm.zaddrData.setterm.iftno Data.setterm.portnoData.setterm.ptt Response Data data.termret.zaddr 224 Chapter 225 Zeventrcvr Chapter 227 228 Chapter 229 Zcomsetypenode ‘C’ structure for a Zcom Event Message is shown belowChapter 231 232 Zgetshrcvrlist Get list of current shared receivers ZgetshrcvrlistIs terminated by an entry with a zlu value of 0. Type of data specified by the mode parameter. The listMaximum number of receivers in each type of shared Receiver list is set to ZcMAXSHAREDRCVRS currentlyChapter 235 Zinfo Zinfo 238 Chapter 239 Zinit Calling zinit. See zrntimer3X for more information Default program ZLU queue limitInitialization phase, before any threads are generated Following fields242 Zltmg Error codes and their meanings Zltmx 246 Chapter 247 Zltqueue Usage Appln Queue Progra Returned Nmb LabelGloba Ccccc250 Chapter 251 Zltstore Zltstore Extension area Logical terminal table, for the storageChapter 255 256 Zltup 258 Chapter 259 Zluopen Async-signal Async-cancelUnsafe Unsafe Fork unsafe262 Chapter 263 Zmapr Zmapr Zname Zname Zcom address Chapter 269 Zopen Chapter 271 Pflag NameLimit 273 Zpeek Chapter 275 Zport Chapter 277 Stat For Z7200A, Z7340A and Z7400A ACC Interface cardsCnfg Configuration data 32 bits Ecode Sync Mode Parity Clk Baud Pmode Pmode2 = Not UsedFM1 transition = FM0 transition = Value Parity select No Parity Odd parity Even parity Value Rate 0000 Use Baud2 1000 19,200 PmodeValue Port modeT1 ESF Chapter 283 284 Chapter 285 286 Zptup 288 Zqmve 290 Chapter 291 Zqsze Zqhdp Return param 294 Chapter 295 Zread Chapter 297 Subsection on ‘Message Header’ in the Multiprotocol ACC Not require the returned message header. It is describedProgrammers’ Reference Guide. See the data structure Zmhdtype in zcomsys.h for more detailNo error Ve Zcom error codeRstat Return status 300 Chapter 301 302 Chapter 303 Not a cancellation point ZrntimerTtgen configuration file. If an unknown node number is Means setting the timeout values for ALL remote nodesSpecified, it is rejected with error -6 Zenode Timeout processing is activated on 1-second intervals306 Mhp-mid.ztagw2 Zsend308 Null may be used if the return status is not required 310 Chapter 311 Mode=0 Mode=1 Mode=2 Mode=5 Mode=8 314 Chapter 315 Zsetql Chapter 317 318 Chapter 319 320 Zsetrcvr 322 Chapter 323 Rzap Chapter 325 Ztimr Chapter 327 328
Related manuals
Manual 54 pages 2.24 Kb