41
Grid Software Inc. Calgary, Canada Ph: 1.403.246.1600 Belgrade, Serbia Ph: 381.11.405.77.14 GIBSOC IEC 61850 MMS CLIENT LIBRARY GSE – GOOSE/GSSE Reference Manual

GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  • Upload
    others

  • View
    6

  • Download
    0

Embed Size (px)

Citation preview

Page 1: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 

                                                                                                                             

   

Grid Software Inc.    Calgary, Canada Ph: 1.403.246.1600 Belgrade, Serbia Ph: 381.11.405.77.14 

 

 

 

GIBSOC IEC 61850 MMS CLIENT LIBRARY 

 

GSE – GOOSE/GSSE Reference Manual  

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Page 2: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  

Contentts  

Conten .....................nts ...................................... ........................................... ............................ 2 .....................

1.  GOOOSE LIB .......... ................................................................ ............................ 7 ..................... .....................

1.1  ................................................................ ............................ 7 goose_t ........................... .....................

1.2  goose_vlan__t .................................................................................. ............................ 8 .....................

1.3  goose_data__t .................................................................................. ............................ 9 .....................

1.4  goose_data__t .................................................................................. .......................... 10 .....................

1.5  goose_from__eth ............................................................................. .......................... 12 .....................

1.6  goose_from__xml ............................................................................. .......................... 12 .....................

goose_to_etth .................................................................................. .......................... 13 1.7  .....................

1.8  goose_to_xmml ................................................................................. .......................... 13 .....................

1.9  goose_to_xmml_file .......................................................................... .......................... 14 .....................

goose_get_rresult_string ................................................................. .......................... 14 1.10  .....................

1.11  goose_init ....................................................................................... .......................... 15 .....................

1.12 

1.13 

1.14 

1.15 

1.16 

1.17 

1.18 

1.19 

1.20 

1.21 

1.22 

1.23 

1.24 

1.25 

1.26 

goose_add_data_bits ..................................................................... .......................... 15 .....................

goose_add_data_boolean .............................................................. .......................... 16 .....................

goose_add_data_bits ..................................................................... .......................... 16 .....................

goose_add_data_integerr ............................................................... .......................... 17 .....................

goose_add_data_uintegeer ............................................................. .......................... 17 .....................

goose_set_aappid ............................................................................ .......................... 18 .....................

goose_add_data_bits ..................................................................... .......................... 18 .....................

goose_set_ddatSet ........................................................................... .......................... 19 .....................

goose_set_ddestination_mmac .......................................................... .......................... 19 .....................

goose_set_ggocbRef ........................................................................ .......................... 20 .....................

goose_set_ggoID .............................................................................. .......................... 20 .....................

goose_set_nndsCom ........................................................................ .......................... 20 .....................

goose_set_ssource_mac .................................................................. .......................... 21 .....................

goose_set_ssqNum .......................................................................... .......................... 21 .....................

goose_ set_sstNum .......................................................................... .......................... 22 .....................

GSE 13‐

Reference Maanual  M‐en 

2 GGS‐002‐GSE‐R

 

Page 3: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 goose_ set_t .....................1.27  t ................... ........................................... .......................... 22 .....................

1.28  .....................goose_ set_ttest............................................................................... .......................... 23 

1.29  .....................goose_set_timeAllowedttoLive ...................................................... .......................... 23 

1.30  .....................goose_set_vvlan ............................................................................... .......................... 23 

1.31  .....................goose_unsett_goID .......................................................................... .......................... 24 

1.32  .....................goose_unsett_vlan ........................................................................... .......................... 24 

1.33  .....................goose_validaation ............................................................................ .......................... 25 

2.  GSSEE LIB ............. ................................................................ .......................... 26 ..........................................

gsse_t ......... ..........................................2.1  ................................................................ .......................... 26 

gsse_data_li .....................ink_layer_t .................................................................. .......................... 27 2.2 

gsse_networrk_layer_t .................................................................... .......................... 27 .....................2.3 

.....................2.4  gsse_transpoort_layer_t .................................................................. .......................... 28 

.....................gsse_sessionn_layer_t ...................................................................... .......................... 28 2.5 

gsse_presentation_layer__t ............................................................. .......................... 28 .....................2.6 

gsse_presen .....................2.7  tation_conteex_definition_t ...................................... .......................... 29 

gsse_applica .....................ation_layer_tt ............................................................... .......................... 30 2.8 

gsse_messagge_t .............................................................................. .......................... 31 .....................2.9 

gsse_LSentDData_t ........................................................................... .......................... 32 .....................2.10 

.....................gsse_result__t ................................................................................... .......................... 33 2.11 

gsse_from_eeth ................................................................................ .......................... 37 .....................2.12 

gsse_from_xxml ............................................................................... .......................... 37 .....................2.13 

gsse_to_eth .................................................................................... .......................... 38 .....................2.14 

gsse_to_xmll .................................................................................... .......................... 39 .....................2.15 

gsse_to_xmll_file ............................................................................. .......................... 39 .....................2.16 

gsse_validattion ............................................................................... .......................... 40 .....................2.17 

gsse_get_ressult_string ................................................................... .......................... 40 .....................2.18 

gsse_init ..... ................................................................ .......................... 41 ..................... .....................2.19 

 

 

 

 

GSE 13‐G

Reference Maanual  M‐en 

3 GS‐002‐GSE‐R

 

Page 4: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  

 

 

 

 

 

INTENTIONALLY LEFT B

                   

GSE 13‐G

BLANK 

Reference Maanual  M‐en 

4 GS‐002‐GSE‐R

 

Page 5: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 

  Copyrightt 2013 Grid Sooftware Inc.  All rights resserved. Copyrighht in this documeent is owned by Grid Software Innc.  Grid Softwaright to subldevelop appimplement i

are Inc. hereby grlicense) under thplications intendin any portion of

rants to you at nhe Grid Softwareded to run on thef this document.

no charge a non‐e inc intellectuale GIBSOC library 

‐exclusive, non‐tl property rights exclusively, pro

transferable, woto evaluate andvided that such 

orldwide, limitedd practice this doapplications do 

d license (withouocument in ordernot themselves 

ut the r to 

 for productive oOther than this limited licennse you shall havve no right to usee the document  or commercial usse. 

 This publicaimplied war

ation is provided rranties of merch

"AS IS" without hantability, fitne

warranty of anyess for a particul

y kind, either explar purpose, or n

pressed or implienon‐infringemen

ed, including, but. 

ut not limited to,, the 

 This publicaherein. Thesand/or chan

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

ation could includse changes will bnges to the docu

de technical inacbe incorporated ument(s) and/or 

ccuracies or typoin new editions the program(s) 

ographical errorsof the publicatiodescribed in this

GSE 13‐G

rs. Changes are pon. Grid Smart Ss publication at a

Reference MaGS‐002‐GSE‐R

periodically addetep Inc may makany time. 

ed to the informke improvement

ation ts 

anual  M‐en 

 

Page 6: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 ABBREVATIONNS 

 ACS Abstract CoSI    ommunication Service Inteerface GIBBSOC    GSS 61850 MMS Client LLibrary 

GSS 61850 GIBBSOCG   MMS Client LLibrary with GGSE (GOOSE/GGSSE) implemmentation GOOSE/GSSGSEE    SE Publisher SSubscriber Libbrary 

IEDD     Intelligent Electronic Deevices   Internet PrIP  otocol 

InternationISOMMMMODPOSCSTCPXM  ABO Thi2.0imp It isfun

  

AU Thiimp  ASS C la DES C la    

O    nal Organization for Standaardization MS    Manufacturing Messagee Specificationn (ISO 9506)

MMS ProtoMS Lib    ocol Supportinng Library encoding andDATA    Library Suppporting ASN. d decoding  1 Data Type, 

RTABLE SM   P   ML Lib   

OUT THIS MA

s is the Refer.69. This manplementation

s not intentionctionalities, p

DIENCE 

s document iplementing th

SUMED KNOW

anguage prog

SIREABLE KNO

anguage expe

Abstract LibSpecific CoTransmissioXML conve

ANUAL 

ence Manualnual is not int differences w

n of the referplease refer r

s intended fohe IEC 61850 

WLEDGE 

gramming 

OWLEDGE 

erience with k

brary enablinmmunicationon Control Prrsion Library

l for the GIBSended for usewith previous

rence manuaather to ‘GIBS

or Software Enbased applica

knowledge of

g multiple OSn Service Maprotocol 

OC IEC 61850e with any olds versions.  

l to provide aSOC User Gui

ngineers, Softations for inte

f Poll/select, T

GSE 13‐G

S to use samee foundation interfaces pping 

0 Client MMSder version d

 Library, versue to functio

ion 1.0 throuonal or 

gh 

an in depth exide’ (13‐GS‐00

xplanation of 03‐GIBS‐UG‐e

the GIBSOC en). 

tware Develoelligent elect

opers and Tesronic devices

st personnel s (IED). 

TCP sockets eetc. 

Reference Maanual  M‐en 

6 GS‐002‐GSE‐R

 

Page 7: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  

1. G 

GOOSEE LIB 

Generic Smechanisassociatiothe multic

ubstation Evem of transferon model in wcast services. 

ent (GSE) is a rring event dawhich substati 

control modata within theion event me

el defined bye substation nessages are pu

y the IEC 6185network. The ublished to m

50 that providGSE rely on t

multiple physic

des a fast the multicast cal devices ussing 

The GSE cGSSE (Gen GOOSE damechanisimplemen  

  1.1 goo

 The gooseThe goose

 typedef st{ odata_maodata_maodata_bogoose_vlauint16_t  odata_strodata_intodata_strodata_boodata_strodata_timodata_intodata_intodata_boodata_intodata_boodata_int

control modeneric Substat

ata is embeddm on multicantation suppo

ose_t 

e_t is a data te_t is the mo

truct goose_t

ac_t       destinac_t       sourcoolean_t   havan_t      vlan;         appid; ring_t    gocbRteger_t   timering_t    datSeoolean_t   havring_t    goID;mestamp_t t; teger_t   stNuteger_t   sqNuoolean_t   testteger_t   confoolean_t   ndsteger_t   num

l is composedion State Eve

ded into Etheast MAC addrorts usage of t

type that const important 

nation_mac; ce_mac; ve_vlan; 

Ref; eAllowedtoLivet; ve_goID; ; 

um; um t; fRev; sCom; DatSetEntries

d of the GOOSnts) models.

ernet data pacesses. GOOSEthe IEEE 802.

tains informastructure in t

ve; 

s; 

SE (Generic O

ckets that areE standard an1Q  which pr

ation inheritethe GOOSE lib

GSE 13‐G

Object Oriente

e exchanged und the GIBSOCovides Priorit

ed from the Gbrary and con

Reference MaGS‐002‐GSE‐R

ed Substation

using publishC GOOSE libraty and Virtual

n Events) and

er‐subscriberary protocol l LAN tagging

 the 

OOSE Ethernntains the foll

et data packeowing fields:

ets. 

anual  M‐en 

 

Page 8: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 goose_daodata_siz} goose_t; 

ata_t      allDaze_t      allData; 

ta[GOOSE_Ma_number; 

MAX_ALLDATAA_NUMBER];

Where: destinatiosource_mhave_vlanvlan – conappid ‐  pgocbRef –timeAllowdatSet – thave_goIDgoID ‐  GOt ‐ GOOSEstNum ‐ csqNum ‐ ctest ‐ testconfRev –ndsCom ‐ numDatSeallData[GallData_n

 Each mem

 (*1) The d(*2) The r(*3) Increchanged ((*4)  This GOOSE_M

  1.2 goo This data typedef st{ uint8_t     

on_mac ‐ contmac ‐ containsn ‐ provides inntains the VLArovides the a– represents twedtoLive ‐ timthe IEC 61850D ‐ provides iOOSE identificE packet time ounter reprecounter repre bit flag  – counter reprneeds commetEntries ‐ nuOOSE_MAX_number ‐ num

mber of the go

destination mreserved GOOments each t( has a new vaarray contain

MAX_ALLDATA

ose_vlan_t

type containstruct goose_v

    priority_co

tains destinat source MAC nformation if AN Identifier pplication idethe referenceme allowed to0 data contain

tion MAC addaddress. there is exist(VID) entifier (*2)e to the GOOSo live of the mner holding da

dress. (*1) 

tence of the V

SE Control Blomessage in mata objects &

Virtual LAN (8

ock that descrilliseconds 

& attributes be

802.1q) tag 

ribes this GOO

eing exchang

OSE packet.

ed nformation ifcation, also spreferencing tsenting stateesenting sequ

resenting nummissioning flagumber of data_ALLDATA_NUmber of used f

oose_t struct

multicast addrOSE appid valutime when at alue) ns values of fiA_NUMBER is

s a value of thvlan_t 

ode_point; 

f there is exispecified by ththe last state  changes (*3)uences of the 

mber of config indication ua set entries inUMBER]‐ arrafields in the a

ture can be ac

ess has to beue has a rangleast one of t

elds specifieds set to 32. 

he Virtual LAN

tence of the he GOOSE conchange )  re‐published

guration chased for maintn the allDatay of the goosllData array.

ccessed with 

 configured fge of 0x0000 tthe data attri

d in the DatSe

GOOSE ID (gontrol block re

 original GOO

nges tenance purp array  se_data_t dat

GOOSE relate

or transmissito 0x3FFF. ibute values r

et and refere

oID) ference (gocb

OSE messages

poses  

ta type 

ed functions 

on of GOOSE

referenced by

nced by the g

bRef) 

described be

y the datSet h

gocbRef. 

low. 

has 

ds: N. The structuure contains ffollowing fiel

GSE 13‐

Reference Maanual  M‐en 

8 GGS‐002‐GSE‐R

 

Page 9: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

odata_bouint16_t  } goose_vpriority_ccanonical_identifier 

  1.3 goo This data 

 typedef st{ goose_dagoose_da} goose_d

 The type ftypedef en{ GOOSE_DGOOSE_DGOOSE_DGOOSE_DGOOSE_DGOOSE_D} goose_d

 The value

 typedef un{ odata_boodata_bitodata_intodata_uinodata_flo} goose_d 

oolean_t cano      identifier;vlan_t; code_point ‐ vl_format_indi‐ value of VLA

ose_data_t

type contains

truct goose_d

ata_type_t  tyata_value_t vadata_t; 

field gives typnum goose_d

DATA_TYPE_NDATA_TYPE_BDATA_TYPE_BDATA_TYPE_INDATA_TYPE_UDATA_TYPE_Fdata_type_t; 

e field provide

nion goose_d

oolean_t  valuts_t     value_bteger_t  valuenteger_t valuoat_t    value_data_value_t;

onical_format; 

value of Prioriicator ‐ value AN Identifier 

s the value an

data_t 

ype; alue; 

pe and is defindata_type_t 

NONE, BOOLEAN, BITS, NTEGER, UINTEGER, FLOAT 

es a value and

data_value_t

ue_boolean; bits; e_integer; e_uinteger; _float; ; 

t_indicator;

ity Code Poinof Canonical 

nd type of a d

ned as follow

d is defined a

t (PCP) l Format Indic

data attribute

ws: 

s follows: 

GSE 13‐G

cator (CFI) 

e part of the I

Reference MaGS‐002‐GSE‐R

EC 61850 Dat

anual  M‐en 

taSet. 

 

 

Page 10: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 1.4 goo This data approprianegative v

 The goose

 typedef en{  GOOSE_O GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E

ose_data_t

type is returnate GOOSE ervalues. 

e_result_t da

num goose_r

OK = 0, ERROR_GENEERROR_ALLDAERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_BAD_ERROR_DIFFEERROR_INAPPERROR_INAPPERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSI

ned by the GOror is returne

ata type is def

result_t 

ERIC = ‐100, ATA_NO_SPAALLDATA = ‐1APPID = ‐103CONFREV = ‐DATA = ‐105,DATSET = ‐10DESTINATIONGOCBREF = ‐1GOID = ‐109,NDSCOM = ‐1NUMDATSETSOURCE_MASQNUM = ‐11STNUM = ‐11T = ‐115, TEST = ‐116, TIMEALLOWEVLAN = ‐118,VLAN_INFO =XML = ‐120, ERENT_NUMDPROPRIATE_LPROPRIATE_TING_ALLDATAING_APPID = ING_CONFREING_DATSET ING_DESTINA

OOSE functioed. GOOSE_O

fined as enum

ACE = ‐101, 102, 3, 104, , 06, N_MAC = ‐10108,  110, TENTRIES = ‐1AC = ‐112, 13, 14, 

EDTOLIVE = ‐1 = ‐119, 

DATSETENTRILENGTH = ‐12TAG = ‐123,A = ‐124, ‐125, V = ‐126, = ‐127, ATION_MAC =

ns. On succesK is set to 0, w

m type that fo

7, 

11, 

117, 

IES = ‐121, 22, 

= ‐128, 

GSE 13‐G

ss GOOSE_OKwhile the GO

ollows: 

Reference MaGS‐002‐GSE‐R

K is returned OSE error res

anual  M‐en 

and on error sults are set t

 

to the 

10 

 

Page 11: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E GOOSE_E

ERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MISSIERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_MULTERROR_NO_SERROR_OUT_ERROR_RESERERROR_UNKNERROR_UNKNERROR_UNKNERROR_UNKN

ING_ETHTYPEING_ETHTYPEING_GOCBREING_GOID = ‐ING_LENGTH ING_LENGTH_ING_NDSCOMING_NUMDAING_RESERVEING_SOURCE_ING_SQNUM ING_STNUM ING_T = ‐141,ING_TAG = ‐1ING_TEST = ‐1ING_TIMEALLING_VLAN = ‐ING_VLAN_INTI_ALLDATA =TI_APPID = ‐1TI_CONFREV =TI_DATSET = ‐TI_DESTINATITI_GOCBREF =TI_GOID = ‐15TI_NDSCOM =TI_NUMDATSTI_SECURITY =TI_SOURCE_MTI_SQNUM = TI_STNUM = ‐TI_T = ‐160, TI_TEST = ‐16TI_TIMEALLOTI_VLAN = ‐16SPACE_FOR_E_OF_BOUNDSRVED_IS_NONNOWN_DATANOWN_ETHTYNOWN_ETHTYNOWN_XML_

E_FROM_ETHE_FROM_VLAEF = ‐131, ‐132, = ‐133, _OF_GOOSE M = ‐135, TSETENTRIESED = ‐137, _MAC = ‐138,= ‐139, = ‐140, , 142, 143, LOWEDTOLIV‐145, NFO = ‐146,= ‐147, 48, = ‐149, ‐150, ION_MAC = ‐1= ‐152, 53, = ‐154, SETENTRIES = = ‐156, MAC = ‐157,‐158, ‐159, 

1, WEDTOLIVE =63, ETH = ‐164, S = ‐165, N_ZERO = ‐16 = ‐167, YPE_IN_ETH =YPE_IN_VLANTAG = ‐170,

H = ‐129, AN = ‐130, 

= ‐134, 

S = ‐136, 

VE = ‐144, 

151, 

‐155, 

= ‐162, 

66, 

= ‐168, N = ‐169, 

GSE 13‐

Reference Maanual  M‐en 

11 GGS‐002‐GSE‐R

 

Page 12: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  GOOSE_E GOOSE_E GOOSE_E GOOSE_R} goose_re

  1.5 goo NAME   

SYNOPSIS

      

 DESCRIPT               

 RETURN V   

 

 1.6 goo

 NAME  go

SYNOPSIS     

 

ERROR_WRONERROR_WRONERROR_WRONRESULT_END_esult_t; 

ose_from_

goose_

S  goose_

( _IN_  c_IN_  c_OUT__OUT_); 

TION  The gocapturwhich the takthe nustructu

VALUE The govalue i

ose_from_

oose_from_x

S  goose_( _IN_  c_IN_  c_OUT_); 

NG_LENGTH_NG_SIZE_OF_NG_SIZE_OF__ 

_OF_GOOSE =_ALLDATA = ‐_SEQUENCE =

= ‐171, 172, = ‐173, 

_eth 

_from_eth ‐ f

_result_t goo

const odata_const odata__       odata_s_       goose_t

oose_from_ered Ethernet holds an octeken_source_sumber of takeure. 

oose_from_eis returned. 

_xml 

xml ‐  fills goo

_result_t goo

const xml_t* const xml_ele_       goose_t

fills goose_t s

ose_from_eth

octet_t* sousize_t   sourcize_t*  taken*       goose 

th() function packet. The set array; the ssize argumenen  source ele

th() function 

ose_t structur

ose_from_xm

             xml,ement_index*            goose

structure with

rce, ce_size, _source_size

fills goose_tsource argumsource_size ant  points to thements; the G

returns GOO

re with data f

ml 

x_t element_ie 

GSE 13‐G

h data from oodata_octet__t structure 

structure witment points toargument conhe odata_sizGOOSE argum

th an octet aro the odata_ontains the nume_t structureent points to

rray that contoctet_t structmber of octete which will hoo the goose_t

tains  ure  ts;  old  t  

OSE_OK on succcess; on erroor a negative  

from xml_t sttructure 

index, 

Reference Maanual  M‐en 

12 GS‐002‐GSE‐R

 

Page 13: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 DESCRIPT

   

TION  The gostructuoften tthe GO

oose_from_xure. Populatinthat is XML_EOOSE argume

 RETURN V   

 

1.7 goo

 

NAME   

SYNOPSIS

      

 DESCRIPT            

 RETURN V   

 

1.8 goo

 

NAME   

SYNOPSIS

   

VALUE The govalue i

ose_to_eth

goose_

S  goose_

( _OUT__IN_  c_OUT__IN_  c); 

TION  The gorepresstructutaken_the nu

VALUE The goreturn

ose_to_xm

goose_

S  odata_

( _IN_  c_OUT_

oose_from_xis returned. 

_to_eth ‐ fills

_result_t goo

_       odata_oconst odata__       odata_sconst goose_

oose_to_eth(sented by odaure and its siz_destination_umber of gene

oose_to_eth(ed. 

ml 

_to_xml ‐ cre

_size_t goose

const goose__       char*     

ml() functionng starts at thELEMENT_ROent points to t

 fills goose_the index givenOOT(0); The xmthe goose_t s

t structure witn by the elemml argument structure. 

th data from ment_index ar points to the

the xml_t rgument, moe xml_t struc

st cture; 

xml() functionn returns GOOOSE_OK on suuccess; on errror a negativee  

s odata_octett_t structure with data froom the goose_e_t structure

ose_to_eth 

octet_t* destiination, size_t   destinnation_size,ize_t*  taken_destination__size, _t*       goose

)  function traata_octet_t dze is represen_size argumeerated octets

ansforms goodata type. Thented by the dent points to ts. The GOOSE

ose_t structue destinationestination_sizthe odata_siz argument po

re into an octpoints to theze argumet. Tze_t structureoints to the g

tet array  e odata_octetThe  e which will hoose_t struct

t_t  

hold  ture. 

) function retturns GOOSE__OK on succeess; on error aa negative value is  

eates strings wwith xml reprresentation off the goose_tt structure. 

e_to_xml 

_t*     goose,   destinationn, 

GSE 13‐

Reference Maanual  M‐en 

13 GGS‐002‐GSE‐R

 

Page 14: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

     

 DESCRIPT            

 RETURN V

 

1.9 goo

 

NAME   SYNOPSIS

      

 DESCRIPT         

RETURN V

 

1.10 goo NA

 SYN

_IN_  c_IN_  c_IN_  c); 

TION  The gostructuelemespacesby ind

VALUE The go

ose_to_xm

goose_S  odata_

( _IN_  c_OUT__IN_  c_IN_  c); 

TION  The gointo thstructunew lin

VALUE The go

ose_get_re

ME   

NOPSIS 

const odata_size_t destinaation_size,   depth, const int        

const int          depth_step

oose_to_xml(ure and copient points to ts printed befoent. This func

() function crees it to the buthe goose_t sore every newction does no

eates strings uffer pointed structure; thew line and depot write more

with xml repto by the dese depth argumpth_step is th than destina

resentation ostination argument is the amhe number ofation_size byt

of the goose_ument. The GOmount of leadf spaces realiztes. 

_t  OOSE ding  zed  

oose_to_xml(() function retturns a numbber of writtenn xml characteers. 

ml_file 

_to_xml_file _size_t goose

‐ writes xml e_to_xml_file

representatioe 

on of the gooose_t structurre into a file.

const goose__t* goose, _       FILE*    ffile, const int      ddepth, const int      ddepth_step 

oose_to_xml_he file given bure; the deptne and the de

_file() functioby the file argh argument iepth_step is a

on writes a xmgument. The Gs the amounta number of s

ml representaGOOSE elemet of leading spspaces realize

ation of the goent points to tpaces printeded by indent. 

oose_t structthe goose_t d before every

ture  

y  

oose_to_xml__file() functioon returns thee number of wwritten charaacters. 

esult_string

goose_get_

const char*

_result_string

* goose_get_

g ‐ returns a s

_result_string

GSE 13‐G

string describ

bing the resultting code 

Reference Maanual  M‐en 

14 GS‐002‐GSE‐R

 

Page 15: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 ( _IN_ c); 

   

 const goose_rresult_t code

 DESCRIPT      

TION  The godescripgoose_

oose_get_resption. The co_result_t stru

sult_string()  fde argumentucture. 

function  retut contains retu

urns a pointerurned code o

r to a string wof the GOOSE 

with a code function andd its  

RETURN VVALUE The gooose_get_ressult_string()  rreturns a strinng with code description. 

 

1.11 goo 

ose_init 

NAME    goose__init ‐ initializzes goose_t structure 

SYNOPSISS  void gooose_init 

(    

 DESCRIPT      

RETURN V

 

1.12 goo 

NAME   

SYNOPSIS

    

 DESCRIPT      

_OUT__ goose_t* gooose ); 

TION  The goto the the go

VALUE The go

ose_add_d

goose_

S  goose_

( _OUT__IN_  c); 

TION  The gointo anmaxim

oose_init() fugoose_t stru

oose_set_ fun

oose_init() fu

data_bits 

_add_data_b

_result_t goo

_       goose_tconst odata_

oose_add_dan allData goomum length is

nction initialiucture. This functions.  

izes the goosunction must 

e_t structurebe called bef

e. The GOOSE fore any of  

argument po 

oints  

unction does nnot return anny value. 

bits ‐ adds neww odata_bitss_t element innto a goose_ddata_t array

ose_add_dataa_bits 

*      goose,bits_t* valuee 

ata_bits() funcose_data_t ar defined by  G

ction adds nerray. This arraGOOSE_MAX_

ew element pay is a field of_ALLDATA_N

ointed by thef the goose_tUMBER(32). 

e value argumt structure an 

ment  d its  

GSE 13‐

Reference Maanual  M‐en 

15 GGS‐002‐GSE‐R

 

Page 16: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

       

The gothe od

oose argumendata_bits_t st

nt points to thtructure.  

he goose_t sttructure and the value arggument points to  

RETURN V   

GOOSE_OK o n error a negative  VALUE The govalue i

oose_add_dais returned. 

ata_bits() funcction returns  on success; o

 

1.13 goo 

NAME      

SYNOPSIS

    

 DESCRIPT      

  

 RETURN V   

 

1.14 goo 

NAME   

SYNOPSIS

    

 DESCRIPT

ose_add_ddata_booleaan 

goose_array. 

S  goose_

( _OUT__IN_  c); 

TION  The goargumstructu

The gothe od

VALUE The govalue i

ose_add_d

goose_

S  goose_

( _OUT__IN_  c); 

TION  The go

_add_data_b

_result_t goo

_       goose_tconst odata_

oose_add_dament into an aure and its m

oose argumendata_boolean

oose_add_dais returned. 

data_bits 

_add_data_f

_result_t goo

_       goose_tconst odata_f

oose_add_da

boolean ‐ add

ose_add_data

*         goose,boolean_t* v

ata_boolean()allData goose_aximum leng

nt points to thn_t structure.

ata_bits() func

float adds a n

ose_add_data

*       goose,float_t* valu

ata_float() fun

ds new odata_

a_boolean 

value 

) function adde_data_t arrayth is defined 

he goose_t st  

ction returns 

new odata_flo

a_float 

nction adds a

GSE 13‐G

_boolean_t eelement into a goose_dataa_t  

ds new elemey. This array iby GOOSE_M

ent pointed bis a field of thMAX_ALLDATA

by the value he goose_t A_NUMBER(332).  

tructure and the value arggument points to 

GOOSE_OK oon success; on error a negative  

oat_t elemen

 new elemen

Reference MaGS‐002‐GSE‐R

nt into the gooose_data_t aarray. 

nt pointed by the value  

anual  M‐en 

16 

 

Page 17: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 argumstructu

      

ment into an aure and its m

allData gooseaximum leng

_data_t arrayth is defined

y. This array iby GOOSE_M

s a field of thMAX_ALLDATA

he goose_t A_NUMBER(332).  

  

The gothe od

oose argumendata_float_t s

nt points to thstructure.  

he goose_t sttructure and the value arggument points to 

 RETURN V   

VALUE The gonegati

oose_add_dave value is re

ata_float() funeturned. 

nction return

 

1.15 goo 

NAME   

SYNOPSIS

    

 DESCRIPT      

  

 RETURN V   

 

1.16 goo 

NAME   

SYNOPSIS

    

ose_add_d

goose_

S  goose_

( _OUT__IN_  c); 

TION  The goargumstructu

The gothe od

VALUE The gonegati

ose_add_d

goose_

S  goose_

( _OUT__IN_  c); 

data_intege

_add_data_in

_result_t goo

_       goose_tconst odata_

oose_add_dament into an aure and its m

oose argumendata_integer_

oose_add_dave value is re

data_uinteg

_add_data_u

_result_t goo

_       goose_tconst odata_

er 

nteger ‐ adds

ose_add_data

*         goose,integer_t* va

ata_integer() allData goose_aximum leng

nt points to th_t structure. 

ata_float() funeturned. 

ger 

uinteger ‐ add

ose_add_data

*         goose,uinteger_t* v

s new odata_

a_integer 

alue 

function adde_data_t arrayth is defined 

he goose_t st

nction return

ds new odata

a_uinteger 

value 

GSE 13‐G

s GOOSE_OK on success; oon error a  

_integer_t ele

s a new elemy. This array iby GOOSE_M

tructure and 

s GOOSE_OK 

a_uinteger_t 

Reference MaGS‐002‐GSE‐R

ement into a ggoose_data__t  

ment pointed bis a field of thMAX_ALLDATA

by the value he goose_t A_NUMBER(332).  

the value arggument points to 

on success; oon error a  

 a goose_datta_t  element into

anual  M‐en 

17 

 

Page 18: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  DESCRIPT      

TION  The goargumstructu

oose_add_dament into an aure and its m

ata_uinteger(allData goose_aximum leng

) function ade_data_t arrayth is defined 

ds a new elemy. This array iby GOOSE_M

ment pointedis a field of thMAX_ALLDATA

d by the valuehe goose_t A_NUMBER(3

e  

32).  

  

The gothe od

oose argumendata_uintege

nt points to thr_t structure

he goose_t st.  

tructure and the value arggument points to 

 RETURN V   

VALUE The gonegati

oose_add_dave value is re

ata_uinteger(eturned. 

) function retturns GOOSE__OK on succeess; on error aa  

 

1.17 goo 

ose_set_apppid 

NAME   

SYNOPSIS

    

 DESCRIPT   

 RETURN V   

 

1.18 goo 

NAME   

SYNOPSIS

    

goose_

S  goose_

( _OUT__IN_  c); 

TION  The gothe ne

VALUE The govalue i

ose_add_d

goose_

S  goose_

( _OUT__IN_  c); 

_set_appid ‐ 

_result_t goo

_       goose_tconst uint16_

oose argumenew value for t

oose_set_appis returned. 

data_bits 

_set_confRev

_result_t goo

_       goose_tconst odata_

set the value

ose_set_appid

* goose, _t appid 

nt points to thhe appid field

pid() function

v ‐ sets the va

ose_set_confR

*        goose,integer_t con

e of the appid

he goose_t std in the goos

n returns GOO

alue of the co

Rev 

nfRev 

GSE 13‐G

d field in the ggoose_t struccture 

tructure and e_t structure

OSE_OK on su

the appid arge. 

uccess; on err

gument conta

ror a negative

ains  

e  

onfRev field inn the goose_tt structure 

Reference Maanual  M‐en 

18 GS‐002‐GSE‐R

 

Page 19: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  DESCRIPT   

TION  The gocontai

oose argumenns a new valu

nt points to thue for the con

he goose_t stnfRev field in 

tructure and the goose_t

the confRev structure. 

argument  

RETURN V on returns GOOSE_OK. VALUE The gooose_set_connfRev() functi

 

1.19 goo 

ose_set_daatSet 

NAME   

SYNOPSIS

    

 DESCRIPT   

RETURN V

 

1.20 goo 

NAME   

SYNOPSIS

    

 DESCRIPT   

RETURN V

 

goose_

S  extern

( _OUT__IN_  c); 

TION  The goa new 

VALUE The go

ose_set_de

goose_

S  goose_

( _OUT__IN_  c); 

TION  The gonew va

VALUE The go

_set_datSet ‐‐  sets datSet field in goosee_t structure

n goose_result_t goose_seet_datSet 

_       goose_t* goose,  datSet const char*   

oose argumenvalue for the

nt points to the datSet field 

he goose_t stin the goose_

tructure and _t structure.

the datSet arrgument conttains  

OSE_OK on soose_set_dattSet() function returns GO uccess. 

estination__mac 

_set_destina

_result_t goo

_       goose_tconst odata_

oose argumenalue of the de

oose_set_des

tion_mac ‐ se

ose_set_desti

*     goose, mac_t* mac

nt points to thestination_m

stination_ma

ets destinatio

ination_mac

he goose_t stmac field in the

ac() function r

GSE 13‐G

on_mac field in goose_t structure 

tructure and e goose_t str

returns GOOS

Reference MaGS‐002‐GSE‐R

the mac arguructure. 

ument points to a  

cess. SE_OK on suc

anual  M‐en 

19 

 

Page 20: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 1.21 goo

 ose_set_goocbRef 

NAME   

SYNOPSIS

    

 DESCRIPT   

 RETURN V

 

1.22 goo 

NAME   

SYNOPSIS

    

 DESCRIPT   

RETURN V

 

1.23 goo 

NAME   

 SYNOPSIS

goose_

S  goose_

( _OUT__IN_  c); 

TION  The goto a ne

VALUE The go

ose_set_go

goose_

S  goose_

( _OUT__IN_  c); 

TION  The gonew st

VALUE The go

ose_set_nd

goose_

S  goose_

_set_gocbRe

_result_t goo

_       goose_tconst char*   

oose argumenew string valu

oose_set_goc

oID 

_set_goID ‐  s

_result_t goo

_       goose_tconst char*   

oose argumentring value of

oose_set_goI

dsCom 

_set_ndsCom

_result_t goo

f ‐ sets gocbR

ose_set_gocb

* goose,  gocbRef 

nt points to thue of the gocb

cbRef() functi

sets goID field

ose_set_goID

* goose,  goID 

nt points to thf the goID fiel

D() function r

m ‐ sets ndsCo

ose_set_ndsC

Ref field in thee goose_t strructure 

bRef 

he goose_t stbRef field in t

tructure and the goose_t s

the gocbRef structure. 

argument points  

on returns GOOSE_OK on success. 

d in goose_t sstructure 

 

he goose_t stld in the goos

tructure and se_t structure

the goID argue. 

ument pointss to a  

returns GOOSSE_OK on succcess. 

om field in thee goose_t strructure 

Com 

GSE 13‐

Reference Maanual  M‐en 

20 GGS‐002‐GSE‐R

 

Page 21: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 (  

   

 DESCRIPT   

RETURN V

 

1.24 goo 

NAME   

SYNOPSIS

    

 DESCRIPT   

RETURN V

 

1.25 goo 

NAME   

SYNOPSIS

    

 DESCRIPT   

_OUT__       goose_t*        goose,boolean_t nddsCom _IN_  cconst odata_

); 

TION  The gocontai

oose argumenns a new valu

nt points to thue of the ndsC

he goose_t stCom field in t

tructure and the goose_t s

the ndsCom structure. 

argument  

VALUE The gooose_set_ndssCom() function returns GOOSE_OK on success. 

ose_set_soource_mac 

goose_

S  goose_

( _OUT__IN_  c); 

TION  The gonew va

VALUE The go

ose_set_sq

goose_

S  goose_

( _OUT__IN_  c); 

TION  The goa new 

_set_source_

_result_t goo

_       goose_tconst odata_

oose argumenalue of the so

oose_set_sou

qNum 

_set_sqNum 

_result_t goo

_       goose_tconst odata_

oose argumenvalue of the 

_mac ‐ sets th

ose_set_sourc

*     goose, mac_t* mac

nt points to thource_mac fie

urce_mac() fu

‐ sets the sqN

ose_set_sqNu

*        goose,integer_t sqN

nt points to thsqNum field 

he source_ma

ce_mac 

he goose_t steld in the goo

unction return

Num field in t

um 

Num 

he goose_t stin the goose_

GSE 13‐G

ac field in thee goose_t struucture 

tructure and ose_t structur

the mac argure. 

ument points to a  

ns GOOSE_OKK on success. 

the goose_t sstructure 

tructure and _t structure.

the sqNum argument contains  

Reference Maanual  M‐en 

21 GS‐002‐GSE‐R

 

Page 22: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 RETURN VVALUE The gooose_set_sqNNum() functioon returns GOOOSE_OK on ssuccess. 

 

1.26 goo 

ose_ set_sttNum 

NAME   

SYNOPSIS

    

 DESCRIPT   

RETURN V

 

1.27 goo 

NAME   

SYNOPSIS

    

 DESCRIPT   

 RETURN V

 

 

goose_

S  goose_

( _OUT__IN_  c); 

TION  The goa new 

VALUE The go

ose_ set_t 

goose_

S  goose_

( _OUT__IN_  c); 

TION  The goodata_

VALUE The go

_set_stNum 

_result_t goo

_       goose_tconst odata_

oose argumenvalue for the

oose_set_stN

_set_t ‐ sets t

_result_t goo

_       goose_tconst odata_t

oose argumen_timestamp_

oose_set_t() f

‐ sets the stN

ose_set_stNu

*        goose,integer_t stN

nt points to the stNum field 

Num() functio

the odata_tim

ose_set_t 

*           goosetimestamp_t

nt points to th_t structure w

function retu

Num field in thhe goose_t sttructure 

Num 

he goose_t stin the goose_

tructure and _t structure.

the stNum arrgument conttains  

OSE_OK on sn returns GO uccess. 

ose_t structuure mestamp_t fiield in the go

e, t* t 

he goose_t stwith a new va

tructure and lue of the t fi

the t argumeeld in the goo

ent points to tose_t structu

the  re. 

rns GOOSE_OOK on successs. 

GSE 13‐

Reference Maanual  M‐en 

22 GGS‐002‐GSE‐R

 

Page 23: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 1.28 goo

 ose_ set_teest 

NAME   

SYNOPSIS

    

 DESCRIPT   

RETURN V

 

1.29 goo 

NAME      

SYNOPSIS

    

 DESCRIPT      

RETURN V   

 

1.30 goo 

NAME   

goose_

S  goose_

( _OUT__IN_  c); 

TION  The gonew va

VALUE The go

ose_set_tim

goose_structu

S  goose_

( _OUT__IN_  c); 

TION  The goargumstructu

VALUE The gonegati

ose_set_vla

goose_

_set_test ‐  s

_result_t goo

_       goose_tconst odata_

oose argumenalue for the t

oose_set_test

meAllowed

_set_timeAllure 

_result_t goo

_       goose_tconst odata_

oose argumenment contains ure. 

oose_set_timve value is re

an 

_set_vlan ‐  s

ets the test fi

ose_set_test

*        goose,boolean_t te

nt points to thest field in th

t() function re

dtoLive 

owedtoLive ‐

ose_set_time

*        goose,integer_t tim

nt points to tha new value 

meAllowedtoLeturned. 

sets the vlan f

ield in the goose_t structuure 

est 

he goose_t sthe goose_t str

tructure and ructure. 

the test argument containns a  

eturns GOOSE_OK on succcess. 

‐  sets the timmeAllowedtoLLive field in thhe goose_t 

AllowedtoLivve 

meAllowedtoLLive 

he goose_t stfor the timeA

tructure and AllowedtoLive

the timeAllowe field in the 

wedtoLive goose_t  

ror a  Live() functionn returns GOOOSE_OK on suuccess; on er

field in the gooose_t structure 

GSE 13‐G

Reference Maanual  M‐en 

23 GS‐002‐GSE‐R

 

Page 24: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 SYNOPSISS  goose__result_t gooose_set_vlan

(       

 DESCRIPT      

RETURN V   

 

1.31 goo 

NAME   

SYNOPSIS

   

 DESCRIPT   

RETURN V

 

1.32 goo NAME   

 SYNOPSIS

   

_OUT__       goose_t*        goose,_IN_  c_IN_  c_IN_  c); 

TION  The gocanonstructu

VALUE The gois retu

ose_unset_

goose_

S  goose_

( _OUT_); 

TION  The futo the 

VALUE The go

ose_unset_

goose_

S  goose_

( _OUT_); 

const uint8_tt         user_prriority, const odata_const uint16_

oose argumenical_format_ure. 

oose_set_vlarned. 

_goID 

_unset_goID 

_result_t goo

_ goose_t* go

nction un‐setgoose_t stru

oose_unset_g

_vlan 

_unset_vlan 

_result_t goo

_ goose_t* go

boolean_t ca_t        vid 

nt points to th_indicatorand

n() function r

‐ unsets the 

ose_unset_go

oose 

ts the goID fieucture. 

goID() functio

– un‐sets the

ose_unset_vla

oose 

anonical_formmat_indicatorr, 

he goose_t std  and vid arg

tructure; useruments conta

r_priority,  ain new value

 es for  the goose_t 

r a negative vreturns GOOSSE_OK on success; on erro value  

goID field in tthe goose_t sstructure 

oID 

eld in the gooose_t structure. The goosee argument ppoints 

on returns GOOOSE_OK on ssuccess. 

structure e vlan field in the goose_t

an 

GSE 13‐

Reference Maanual  M‐en 

24 GGS‐002‐GSE‐R

 

Page 25: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  DESCRIPT   

TION  The futo the 

nction un‐setgoose_t stru

ts the vlan fieucture. 

eld in the gooose_t structurre. The goosee argument pooints  

RETURN V

 

 

1.33 goo 

NAME   

 SYNOPSIS

   

 DESCRIPT

 RETURN V   

                

VALUE The go

ose_validat

goose_

S  goose_

( _IN_ c); 

TION  This fu

VALUE The govalue i

oose_unset_v

tion 

_validation ‐ 

_result_t goo

const goose_t

unction valida

oose_validatiis returned. 

vlan() functio

validates fiel

ose_validatio

t* goose 

ates fields in t

ion() function

on returns GOOOSE_OK on ssuccess. 

ds in the gooose_t structurre 

the goose_t s

n returns GOO

GSE 13‐G

structure poin

OSE_OK on su

Reference MaGS‐002‐GSE‐R

nted by the G

uccess; on err

GOOSE argum

ror a negative

ent. 

e  

anual  M‐en 

25 

 

Page 26: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  

2. G 

GSSE LIIB 

The GSSE GSSE moda flexible list of stat

 

model is verydel. The signifmeans to spetus informatio

y similar to thficant differenecify which inon. Also, the 

he GOOSE onnce is in the information is GSSE model d

e. The basic cnformation bto be exchandoes not prov

concepts descbeing exchangged (DATA‐SEvide support 

cribed above ged. While thET), the GSSEfor the VLAN 

apply also toe GOOSE proE provides a sitagging. 

o the ovides imple 

 2.1 gssse_t 

 This data structure 

type containsin the GSSE l

s informationibrary and co

n from GSSE Eontains the fo

Ethernet datallowing fields

 typedef st{ gsse_datagsse_netwgsse_trangsse_sessgsse_presgsse_aplicgsse_mes} gsse_t;  Where: data_link_network_transport_session_lapresentataplicationgsse_mes

      

truct gsse_t 

a_link_layer_work_layer_t nsport_layer_sion_layer_t   sentation_laycation_layer_ssage_t           

_layer ‐ provilayer ‐ provid_layer ‐ proviayer ‐ providetion_layer ‐ prn_layer ‐ provssage ‐ provid

t    data_link_     network_lt    transport_   session_lay

yer_t presenta_t   aplication_ gsse_messag

ides data fromdes data fromides data fromes data from trovides data fvides data frodes a GSSE me

_layer; layer; _layer; yer; ation_layer;n_layer; ge; 

m the Data Lim the Networkm the Transpothe Session Lafrom the Presm the Aplicatessage 

nk Layer of thk Layer of theort Layer of tayer of the Osentation Laytion Layer of t

GSE 13‐G

 packet. The s: 

gsse_t is the most important 

he OSI referee OSI referenche OSI refere

OSI reference yer of the OSIthe OSI refer

nce model ce model ence model model  reference mence model 

odel 

Reference Maanual  M‐en 

26 GS‐002‐GSE‐R

 

Page 27: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 2.2 gssse_data_linnk_layer_t 

 This data following 

type containsfields: 

s data from the Data Link Layer of the OOSI referencee model and ccontains the 

 typedef st{ odata_maodata_mauint8_t     uint8_t     uint8_t     } gsse_da Where: destinatiosource_mDSAP, SSA  

2.3 gss

 This data following 

 typedef st{ uint8_t     uint8_t     odata_ocodata_oc} gsse_ne 

Where: pdu_lifetiflags – repdestinatio   

truct gsse_da

ac_t destinatiac_t source_mDSAP; SSAP; control; ta_link_layer_

ata_link_laye

ion_mac; mac; 

r_t; 

er_t 

on_mac – is thmac – is the odAP, control ‐ p

he odata_madata_mac_t wprovide a Log

ac_t with a dewith a sourceical Link Cont

estination MA MAC addrestrol Addresse

AC address.s. s 

se_networkk_layer_t 

type containsfields: 

s data from the Network LLayer of the OOSI reference model and coontains the 

truct gsse_ne

   pdu_lifetim   flags; tets_t destinatets_t source_twork_layer_

etwork_layer_

me; 

ation_address_address; _t; 

_t 

s; 

ime – is the Ppresents the on_address, s

DU lifetime Type code ource_addresss ‐ provide the Network SService Access Point Addreesses 

GSE 13‐

Reference Maanual  M‐en 

27 GGS‐002‐GSE‐R

 

Page 28: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 2.4 gssse_transport_layer_t 

 This data following 

type containsfields: 

s data from the Transport Layer of the OSI referencee model and contains the 

 typedef st{ odata_ocodata_oc} gsse_tra Where: source_adAddresses 

2.5 gss

 This data following 

 typedef st{ odata_ocodata_boodata_ocodata_bo} gsse_ses Where: calling_sehave_callthe sessio

  2.6 gss

 This data following 

 typedef st

truct gsse_tra

tets_t source_tets_t destinaansport_layer_

ansport_laye

_address_TSAation_addressr_t; 

er_t 

AP; s_TSAP; 

ddress_TSAP,s 

 destination__address_TSAAP ‐ representt the Networkk Service Acceess Point 

se_session__layer_t 

type containsfields: 

s data from the Session Laayer of the OSSI reference mmodel and contains the 

truct gsse_se

tets_t  callingoolean_t havetets_t  called_oolean_t havession_layer_t;

ssion_layer_

g_session_sele_calling_sess_session_selee_called_sessit; 

lector; sion_selector;ector; ion_selector;

ession_selectoling_session_son service acc

or, called_sesselector, havecess point add

ssion_selectore_called_sessdresses 

r‐  provide thsion_selector

e session serv‐ provide info

vice access poormation on t

oint addressthe existencee of 

se_presentation_layer_t 

he type containsfields: 

s data from the Presentatiion Layer of tthe OSI refereence model and contains t

truct gsse_prresentation_laayer_t 

GSE 13‐

Reference Maanual  M‐en 

28 GGS‐002‐GSE‐R

 

Page 29: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 { odata_ocodata_boodata_ocodata_boodata_sizgsse_presodata_oidodata_int} gsse_pre 

tets_t calling_oolean_t havetets_t called_oolean_t haveze_t presentasentation_cond_t user_datateger_t user_esentation_la

_presentatione_calling_pres_presentatione_called_prestion_contex_ntex_definitioa_transfer_sydata_presentayer_t; 

n_selector;sentation_seln_selector; entation_seledefinition_lison_t    contex_yntax_name;tation_contex

lector; 

ector; st_number; _definition_li

xt_identifier;

Where: calling_prpoint add

have_call

presentatpresentatparametecontex_deGSSE_PREuser_dataidentifier.user_data“INTEGER

  2.7 gss

 Auxiliary d

 typedef st{ odata_intodata_oidodata_intodata_oidtransfer_s_SIZE]; } gsse_preGSSE_PRESEN

 

resentation_sress ling_presenta

tion service action_contex_der efinition_list ‐ESENTATION_a_transfer_sy. a_presentatioR” field of the 

se_present

data type for 

truct gsse_pr

teger_t presed_t     abstracteger_t transfd_t syntax_name

esentation_coNTATION_CONTEX

selector, calle

ation_selector

ccess point addefinition_list

‐ provides the_CONTEX_DEyntax_name –

on_context_id“EXTERNAL”

ation_cont

the gsse_pre

resentation_c

ntation_contct_syntax_namfer_syntax_na

e_list[GSSE_PR

ontex_definitX_DEFINITION_TRA

ed_presentati

r, have_called

ddresses t_number – re

e array of parFINITION_LIS– provides an 

dentifier ‐ pro 

tex_definiti

esentation_la

contex_defin

text_identifierme; ame_list_num

RESENTATION

tion_t; ANSFER_SYNTAX_

ion_selector ‐

d_presentatio

epresents the

rameter ST_SIZE 32 abstract synt

ovides an inte

ion_t 

ayer_t and co

ition_t 

r; 

mber; 

N_CONTEX_D

_NAME_LIST_SIZE

GSE 13‐G

ist[GSSE_PRESEN

‐ represent pr

on_selector –

e size of the p

tax name of t

eger that is th

ontains the fo

DEFINITION_T

Reference MaGS‐002‐GSE‐R

TATION_CONTEX__DEFINITION_LIST_T_SIZE]; 

resentation se

– are informat

presentation c

the ASN.1 typ

e indirect‐ref

ervice access 

tion related t

context list 

pe object 

ference 

to the 

ollowing fieldss: 

TRANSFER_SYYNTAX_NAMEE_LIST

anual  M‐en 

29 

 

Page 30: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 2.8 gssse_applicattion_layer__t 

 This data following 

type containsfields: 

s data from the Applicatioon Layer of the OSI referennce model andd contains thee 

 typedef st{ odata_bitodata_boodata_oidodata_boodata_oidodata_boodata_oidodata_boodata_intodata_boodata_intodata_boodata_oidodata_boodata_oidodata_boodata_intodata_boodata_intodata_boodata_oidodata_boodata_intodata_bo} gsse_ap Where: protocol_have_proapplicatioContext Nhave_appcalling_APhave_callcalling_AE

truct gsse_ap

ts_t    protocooolean_t haved_t     applicaoolean_t haved_t     calling_oolean_t haved_t     calling_oolean_t haveteger_t callingoolean_t haveteger_t callingoolean_t haved_t     called_Aoolean_t haved_t     called_Aoolean_t haveteger_t calledoolean_t haveteger_t calledoolean_t haved_t     user_infoolean_t haveteger_t user_oolean_t havelication_layer

plication_laye

ol_version; e_protocol_vetion_context_e_application__AP_title; e_calling_AP__AE_qualifier;e_calling_AE_g_AP_invocae_calling_AP_g_AE_invocate_calling_AE_AP_title; e_called_AP_tAE_qualifier; e_called_AE_qd_AP_invocate_called_AP_id_AE_invocate_called_AE_iformation_exe_user_informinformation_e_user_informr_t; 

er_t 

ersion; _name; _context_nam

_title; ; _qualifier; tion_identifie_invocation_idtion_identifie_invocation_id

title; 

qualifier; tion_identifierinvocation_idtion_identifierinvocation_idxternl_direct_mation_extern_externl_indirmation_extern

me; 

er; dentifier; er; dentifier; 

r; dentifier; r; dentifier; _reference;nl_direct_referect_referencenl_indirect_re

erence; e; eference; 

version ‐ provtocol_versionon_context_nName parameplication_contP_title ‐ proviling_AP_title –E_qualifier ‐ p

vides the versn ‐ provides thame ‐ provideeter text_name ‐ pides a value t– provides infprovides a va

sion of the AChe informatioes a value tha

provides inforhat is determformation if tlue that is det

CSE on if there is aat is used to d

rmation on thmined by the vthere is a calltermined by t

a protocol_vedetermine the

he applicationvalue of the Cling_AP_titlethe value of t

ersion e value of the

n_context_naCalling AP Titl

the Calling AE

e Application 

ame  e parameter

E qualifier 

GSE 13‐

Reference Maanual  M‐en 

30 GGS‐002‐GSE‐R

 

Page 31: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 have_callcalling_APinvocationhave_callcalling_AEinvocationhave_callcalled_APhave_callcalled_AEhave_callcalled_APinvocationhave_callcalled_APcalled_AEinvocationhave_callcalled_AEuser_inforinformatiohave_useuser_inforuser_infoUser inforhave_useuser_infor

  2.9 gss

 This data 

 typedef st{ odata_strgsse_LSen} gsse_me

 ObjectNam

ling_AE_qualiP_invocation_n identifier ling_AP_invocE_invocation_n identifier ling_AE_invocP_title ‐ providled_AP_title ‐E_qualifier ‐ ped_AE_qualifP_invocation_n identifier ed_AP_invocP_invocation_E_invocation_n identifier led_AE_invocE_invocation_rmation_exteon external dr_informationrmation_extermation_extermation exterr_informationrmation_exte

se_message

type contains

truct gsse_me

ring_t   ObjecntData_t LSenessage_t; 

me ‐ the Obje

ifier ‐ provide_identifier ‐ p

cation_identif_identifier ‐ p

cation_identifdes a value th provides inforovides a valufier ‐  provide_identifier ‐ p

cation_identif_identifier _identifier ‐ p

ation_identifi_identifier ernl_direct_redirect referenn_externl_dirernl_direct_reernl_indirect_rnal indirect rn_externl_indernl_indirect_

e_t 

s the GSSE m

essage_t 

tName; ntData; 

ectName cho

es informationprovides a val

fier ‐ provideprovides a val

fier ‐ provideshat is determormation on tue that is detes informationrovides a valu

fier ‐ provides

rovides a valu

fier ‐ provides

eference ‐ proce rect_referenceference _reference ‐ preference direct_referen_reference 

essage and co

ice shall be a 

n on the callinue that is det

s if there is a ue that is det

s if there is a ined by the vthe existencetermined by tn on the existue that is det

s information

ue that is det

s information 

ovides a value

e ‐  provides 

provides a va

nce ‐ provides

ng_AE_qualiftermined by t

calling_AP_intermined by t

calling_AE_invalue of the Cae of the calledthe value of thtence of the cermined by t

 on the existe

ermined by t

on the existe

e that is deter

information o

lue that is de

s information

fier the value of t

nvocation_idethe value of t

nvocation_idealled AP title d_AP_title he Called AE called_AE_quhe value of th

ence of the 

he value of th

ence of the 

rmined by the

on the existen

termined by 

n on the existe

he Calling AP

entifier he Calling AE

entifier 

qualifier alifier he Called AP 

he Called AE 

e value of Use

nce of the 

the value of t

ence of the 

 

er 

the 

ontains the foollowing fieldds: 

vmd‐specificc and the idenntifier shall haave the value 

GSE 13‐

Reference Maanual  M‐en 

31 GGS‐002‐GSE‐R

 

Page 32: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

“GOOSE”.LSentData 

 2.10 gss This data 

 typedef st{ odata_strodata_timodata_uinodata_uinodata_uinodata_uinodata_uinodata_bitodata_bit} gsse_LSe Where:  GsID ‐ prot ‐ provideby the GSSqNum ‐ tStNum ‐ tthe LSentDTAL ‐ provusec ‐ comtimestamPhsID ‐ prDNA ‐ provalues whUserSt ‐ pmeaning c

   

. a ‐ provides t

se_LSentDa

type contains

truct gsse_LS

ring_t   GsID; me_t     t; nteger_t SqNunteger_t StNunteger_t TAL;nteger_t usecnteger_t PhsIts_t     DNA; ts_t     UserSt;entData_t; 

ovides the vales the time atSE message. the sequencehe state numData structurvides the timemponent usecp. rovides the phovides the BIThose meaningprovides the Bcorresponds t

he data being

ata_t 

s data values 

entData_t 

um; um; ; c; D; 

ue of the SCBt which the la

e number coumber counter ‐re. eAllowedtoLivc is to be used

hase identificT‐STRING. Theg correspondsBIT‐STRING. Tto the UserST

g sent in the l

associated w

BGsID sent in ast state chan

nter ‐ holds a valu

ve of the last d to convey t

cation e BIT‐STRING s to the DNALThe BIT‐STRINT within the S

last GSSE Mes

within the last

the last GSSEnge was detec

ue which shall

sent messagehe microseco

represents aLabels within G representsSCB. 

GSE 13‐G

ssage. 

t received GSS

E message. cted for the d

l be mapped t

e in millisecoond compone

n array of dothe SCB. s an array of d

Reference MaGS‐002‐GSE‐R

SE message. 

data being iss

to the StNum

nds  ent of the stat

uble‐bit pair 

double‐bit pa

anual  M‐en 

ued 

m component 

te change 

ir values who

 

of 

ose 

32 

 

Page 33: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

   2.11 gssse_result_tt  This data appropriato the neg

type is returnate GSSE errogative values.

ned by the GSr is returned.. 

SSE functions The GSSE_O

. On a succesK is set to 0, a

ss GSSE_OK isand all the ot

 returned whther GSSE err

hile on error aor results are

and e set 

 typedef en{ GSSE_OK = 0,GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_

num gsse_res

, _GENERIC = ‐100, _APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY

sult_t 

YER_BAD_APPLICAYER_BAD_CALLED_YER_BAD_CALLED_YER_BAD_CALLED_YER_BAD_CALLED_YER_BAD_CALLED_YER_BAD_CALLINGYER_BAD_CALLINGYER_BAD_CALLINGYER_BAD_CALLINGYER_BAD_CALLINGYER_BAD_CONTEXYER_BAD_PROTOCYER_BAD_USER_INYER_BAD_USER_INYER_MISSING_APPYER_MISSING_CALYER_MISSING_CALYER_MISSING_CALYER_MISSING_CALYER_MISSING_CALYER_MISSING_CALYER_MISSING_CALYER_MISSING_CALYER_MISSING_CALYER_MISSING_CONYER_MISSING_LENYER_MISSING_PROYER_MISSING_TAGYER_MISSING_USEYER_MISSING_USEYER_MISSING_USEYER_MISSING_USEYER_MULTI_APPLIYER_MULTI_CALLEYER_MULTI_CALLEYER_MULTI_CALLEYER_MULTI_CALLEYER_MULTI_CALLEYER_MULTI_CALLIYER_MULTI_CALLI

ATION_CONTEXT_N_AE_INVOCATION__AE_QUALIFIER = _AP_INVOCATION_AP_INVOCATION_AP_TITLE = ‐106,G_AE_INVOCATIONG_AE_QUALIFIER =G_AP_INVOCATIONG_AP_INVOCATIONG_AP_TITLE = ‐111XT_NAME = ‐112,COL_VERSION = ‐1NFORMATION_EXTNFORMATION_EXTPLICATION_CONTELLED_AE_INVOCATLLED_AE_QUALIFIELLED_AP_INVOCATLLED_AP_TITLE = ‐LLING_AE_INVOCALLING_AE_QUALIFLLING_AP_INVOCALLING_AP_INVOCALLING_AP_TITLE = NTEXT_NAME = ‐1NGTH = ‐127, OTOCOL_VERSIONG = ‐129, ER_INFORMATIONER_INFORMATIONER_INFORMATIONER_INFORMATIONICATION_CONTEXTED_AE_INVOCATIOED_AE_QUALIFIERED_AP_INVOCATIOED_AP_INVOCATIOED_AP_TITLE = ‐13NG_AE_INVOCATING_AE_QUALIFIER

NAME = ‐101, N_IDENTIFIER = ‐10‐103, 

N_IDENTFIER = ‐104N_IDENTIFIER = ‐10 N_IDENTIFIER = ‐1= ‐108, N_IDENTFIER = ‐10N_IDENTIFIER = ‐11, 

13, TERNL_DIRECT_RETERNL_INDIRECT_EXT_NAME = ‐116,TION_IDENTIFIER =ER = ‐118, TION_IDENTIFIER =‐120, ATION_IDENTIFIERFIER = ‐122, ATION_IDENTFIER ATION_IDENTIFIER‐125, 

126, 

N = ‐128, 

N = ‐130, N_EXTERNL_DIRECN_EXTERNL_INDIREN_SINGLE_ASN1_TT_NAME = ‐134,ON_IDENTIFIER = ‐R = ‐136, ON_IDENTFIER = ‐1ON_IDENTIFIER = ‐39, ION_IDENTIFIER = R = ‐141, 

02, 

4, 05, 

107, 

09, 110, 

EFERENCE = ‐114,_REFERENCE = ‐115, = ‐117, 

= ‐119, 

R = ‐121, 

= ‐123, R = ‐124, 

CT_REFERENCE = ‐1ECT_REFERENCE =TYPE = ‐133, 

‐135, 

137, ‐138, 

‐140, 

5, 

131, = ‐132, 

GSE 13‐

Reference Maanual  M‐en 

33 GGS‐002‐GSE‐R

 

Page 34: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_

_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_APLICATION_LAY_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_DATA_LINK_LAYE_ETH_OUT_OF_BO_GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE_

YER_MULTI_CALLIYER_MULTI_CALLIYER_MULTI_CALLIYER_MULTI_CONTYER_MULTI_IMPLEYER_MULTI_PROTYER_MULTI_USER_YER_MULTI_USER_YER_MULTI_USER_YER_MULTI_USER_YER_MULTI_USER_YER_MULTI_USER_YER_UNKNOWN_TER_BAD_DESTINAER_BAD_CONTROER_BAD_DSAP = ‐ER_BAD_SOURCE_ER_BAD_SSAP = ‐1ER_MISSING_CONER_MISSING_DESTER_MISSING_ETH_ER_MISSING_SERVER_MISSING_SOUER_MULTI_CONTRER_MULTI_DESTINER_MULTI_DSAP =ER_MULTI_ETH_LER_MULTI_SERVICER_MULTI_SOURCER_MULTI_SSAP =ER_OUT_OF_BOUOUNDS = ‐173, _BAD_DNA = ‐174,_BAD_GSID = ‐175_BAD_OBJECTNAM_BAD_PHSID = ‐17_BAD_SQNUM = ‐1_BAD_STNUM = ‐1_BAD_T = ‐180, _BAD_TAL = ‐181, _BAD_USEC = ‐182_BAD_USERST = ‐1_INAPPROPRIATE__LAYER_MISSING__MISSING_DNA = _MISSING_GSID = _MISSING_LSENTD_MISSING_OBJECT_MISSING_PHSID =_MISSING_SQNUM_MISSING_STNUM_MISSING_T = ‐193_MISSING_TAG = ‐_MISSING_TAL = ‐1_MISSING_USEC =_MISSING_USERST_MULTI_DNA = ‐19_MULTI_GSID = ‐1

NG_AP_INVOCATING_AP_INVOCATING_AP_TITLE = ‐1TEXT_NAME = ‐145EMENTATION_INFTOCOL_VERSION = _INFORMATION =_INFORMATION_E_INFORMATION_E_INFORMATION_E_INFORMATION_E_INFORMATION_STAG = ‐154, TION_MAC = ‐155

OL = ‐156, 157, _MAC = ‐158, 159, NTROL = ‐160, TINATION_MAC = _LENGTH = ‐162,VICE_ACESS_POINURCE_MAC = ‐164,ROL = ‐165, NATION_MAC = ‐1= ‐167, ENGTH = ‐168, CE_ACESS_POINT =CE_MAC = ‐170,= ‐171, UNDS = ‐172, 

, 5, ME = ‐176, 77, 178, 179, 

2, 183, _TAG = ‐184, _LENGTH = ‐185,‐186, ‐187, DATA = ‐188, TNAME = ‐189, = ‐190, M = ‐191, M = ‐192, 3, ‐194, 195, = ‐196, T = ‐197, 98, 99, 

ION_IDENTFIER = ION_IDENTIFIER =44, 5, FORMATION = ‐146‐147,  ‐148, EXTERNL_DATA_VEXTERNL_DIRECT_EXTERNL_IDIRECT_EXTERNL_INDIRECSINGLE_ASN1_TYP

5, 

‐161, 

NT = ‐163, 

66, 

= ‐169, 

GSE 13‐G

‐142,  ‐143, 

6, 

VALUE_DESCRIPTO_REFERENCE = ‐150_REFERENCE = ‐15CT_REFERENCE = ‐1PE = ‐153, 

Reference MaGS‐002‐GSE‐R

OR = ‐149, 0, 51, 152, 

anual  M‐en 

34 

 

Page 35: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_

_GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__GSSE_MESSAGE__INAPPROPRIATE__MISSING_APLICA_MISSING_DATA__MISSING_GSSE_M_MISSING_LENGT_MISSING_NETWO_MISSING_PRESEN_MISSING_SESSIO_MISSING_TAG = _MISSING_TRANS_MULTI_APLICATI_MULTI_DATA_LIN_MULTI_GSSE_ME_MULTI_NETWOR_MULTI_PRESENT_MULTI_SESSION__NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NETWORK_LAYE_NO_SPACE_FOR__OUT_OF_BOUND_PRESENTATION__PRESENTATION__PRESENTATION_

_MULTI_LSENTDA_MULTI_OBJECTNA_MULTI_PHSID = ‐_MULTI_SQNUM =_MULTI_STNUM =_MULTI_T = ‐205, _MULTI_TAL = ‐20_MULTI_USEC = ‐2_MULTI_USERST =_TAG = ‐209, ATION_LAYER = ‐21_LINK_LAYER = ‐21MESSAGE_LAYER =TH = ‐213, ORK_LAYER = ‐214NTATION_LAYER =ON_LAYER = ‐216, ‐217, SPORT_LAYER = ‐21ION_LAYER = ‐219NK_LAYER = ‐220, ESSAGE = ‐221, RK_LAYER = ‐222, TATION_LAYER = ‐2_LAYER = ‐224, ER_BAD_DESTINATER_BAD_FLAGS = ‐2ER_BAD_IDENTIFICER_BAD_PDU_LIFEER_BAD_PROTOCOER_BAD_SOURCE_AER_BAD_SOURCE_ER_HEADER_LENGER_MISSING_CHECER_MISSING_DESTER_MISSING_DESTER_MISSING_FLAGER_MISSING_HEADER_MISSING_IDENER_MISSING_LENGER_MISSING_PDU_ER_MISSING_PROTER_MISSING_SEGMER_MISSING_SOURER_MISSING_SOURER_MULTI_CHECKSER_MULTI_DESTINER_MULTI_DESTINER_MULTI_FLAGS =ER_MULTI_PDU_LIER_MULTI_SOURCEER_MULTI_SOURCEER_OUT_OF_BOUN_ETH = ‐253, DS = ‐254, _CONTEX_LIST_SIZ_LAYER_BAD_ABST_LAYER_BAD_CALL

TA = ‐200, AME = ‐201, ‐202, = ‐203, = ‐204, 

06, 207, = ‐208, 

10, 11, = ‐212, 

4, = ‐215, 

18, 9, 

223, 

TION_ADDRESS = ‐226, CATOR_CLNP = ‐22ETIME = ‐228, OL_VERSION = ‐229ADDRESS = ‐230,DESTINATION_ADTH_OUT_OF_BOUCKSUM_SIZE = ‐233TINATION_ADDRESTINATION_ADDRESGS = ‐236, DER_LENGTH = ‐23TIFICATOR = ‐238,GTH = ‐239, _LIFETIME = ‐240,TOCOL_VERSION =MENT_LENGTH = ‐2RCE_ADDRESS = ‐2RCE_ADDRESS_LENSUM = ‐245, NATION_ADDRESS NATION_ADDRESS_= ‐248, IFETIME = ‐249,E_ADDRESS = ‐250E_ADDRESS_TSAPNDS = ‐252, 

ZE_NO_SPACE = ‐25TRACT_SYNTAX_NLED_PRESENTATIO

‐225, 

27, 

9, 

DDRESS = ‐231, UNDS = ‐232, 3, SS = ‐234, SS_LENGTH = ‐235,

37,  

= ‐241, 242, 243, NGTH = ‐244, 

= ‐246, _TSAP = ‐247, 

0, P = ‐251, 

55, NAME = ‐256, ON_SELECTOR = ‐25

GSE 13‐G

5, 

57, 

Reference Maanual  M‐en 

35 GS‐002‐GSE‐R

 

Page 36: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_

_PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__PRESENTATION__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__SESSION_LAYER__TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY_TRANSPORT_LAY

_LAYER_BAD_CALL_LAYER_BAD_PRES_LAYER_BAD_SOUR_LAYER_BAD_TRAN_LAYER_BAD_USER_LAYER_BAD_USER_LAYER_CONTEX_L_LAYER_INAPPROP_LAYER_MISSING_A_LAYER_MISSING__LAYER_MISSING__LAYER_MISSING__LAYER_MISSING__LAYER_MISSING__LAYER_MISSING__LAYER_MISSING__LAYER_MISSING__LAYER_MISSING__LAYER_MULTI_AB_LAYER_MULTI_CA_LAYER_MULTI_CA_LAYER_MULTI_PR_LAYER_MULTI_PR_LAYER_MULTI_PR_LAYER_MULTI_PR_LAYER_MULTI_US_LAYER_MULTI_US_LAYER_MULTI_US_LAYER_OUT_OF_B_LAYER_PRESENTA_LAYER_UNKNOWN_LAYER_UNKNOWN_BAD_CALLED_SES_BAD_CALLING_SE_BAD_PROTOCOL__MISSING_CALLED_MISSING_CALLIN_MISSING_HEADER_MISSING_LENGTH_MISSING_PROTO_MISSING_TAG = ‐_MULTI_CALLED_S_MULTI_CALLING__MULTI_VERSION__OUT_OF_BOUND_UNKNOWN_TAG YER_BAD_DESTINAYER_BAD_IDENTIFYER_BAD_SOURCEYER_BAD_SOURCEYER_MISSING_DESYER_MISSING_HEAYER_MISSING_IDEYER_MISSING_LENYER_MISSING_SOUYER_MISSING_TAGYER_MULTI_DESTIYER_MULTI_SOUR

LING_PRESENTATIOSENTATION_CONTRCE_ABSTRACT_SNSFER_SYNTAX_NR_DATA_PRESENTR_DATA_TRANSFELIST_SIZE_NO_SPAPRIATE_TAG = ‐265ABSTRACT_SYNTACALLED_PRESENTACALLING_PRESENLENGTH = ‐269,PRESENTATION_CTAG = ‐271, TRANSFER_SYNTAUSER_DATA = ‐27USER_DATA_PRESUSER_DATA_TRANBSTRACT_SYNTAX_ALLED_PRESENTATALLING_PRESENTARESENTATION_CONRESENTATION_CONRESENTATION_CONROTOCOL_VERSIONSER_DATA = ‐283,SER_DATA_PRESENSER_DATA_TRANSBOUNDS = ‐286,ATION_LAYER_CONN_TAG = ‐288, N_XML_TAG = ‐28SSION_SELECTOR =ESSION_SELECTOR_IDENTIFICATOR =D_SESSION_SELECTG_SESSION_SELECR_LENGTH = ‐295,H = ‐296, COL_IDENTIFICAT‐298, SESSION_SELECTO_SESSION_SELECTO_NUMBER = ‐301,DS = ‐302, = ‐303, ATION_ADDRESS_FICATOR = ‐305,E_ADDRESS_TSAP E_SOURCE_ADDRESTINATION_ADDREADER_LENGTH = ‐3ENTIFICATOR = ‐31NGTH = ‐311, URCE_ADDRESS_TG = ‐313, INATION_ADDRESSRCE_ADDRESS_TSA

ON_SELECTOR = ‐2TEXT_IDENTIFIER =YNTAX_NAME = ‐2

NAME_LIST = ‐261,TATION_CONTEXT_ER_SYNTAX_NAMEACE = ‐264, 5, AX_NAME = ‐266,TATION_SELECTORTATION_SELECTOR

CONTEXT_IDENTIFI

AX_NAME_LIST = ‐273, SENTATION_CONTNSFER_SYNTAX_N_NAME = ‐276, TION_SELECTOR = ATION_SELECTOR =NTEX_DEFINITIONNTEXT_DEFINITIONNTEXT_IDENTIFIERN = ‐282, 

NTATION_CONTEXSFER_SYNTAX_NAM

NTEX_LIST_SIZE_N

89, = ‐290, R = ‐291, = ‐292, TOR = ‐293, CTOR = ‐294, , 

TOR = ‐297, 

OR = ‐299, OR = ‐200, 

TSAP = ‐304, 

= ‐306, ESS_TSAP = ‐307,ESS_TSAP = ‐308,309, 0, 

TSAP = ‐312, 

S_TSAP = ‐314, AP = ‐315, 

GSE 13‐G

258, = ‐259, 260, 

_IDENTIFIER = ‐262E = ‐263, 

 = ‐267, R = ‐268, 

IER = ‐270, 

272, 

TEXT_IDENTIFIER =NAME = ‐275, 

‐277, = ‐278, N_LIST = ‐279, N_LIST = ‐280, R = ‐281, 

XT_IDENTIFIER = ‐2ME = ‐285, 

NO_SPACE = ‐287,

Reference MaGS‐002‐GSE‐R

2, 

= ‐274, 

284, 

anual  M‐en 

36 

 

Page 37: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_ERROR_GSSE_RESULT

} gsse_res

  2.12 gss NAME   

SYNOPSIS

      

 DESCRIPT            

RETURN V   

 

2.13 gss

 NAME   

SYNOPSIS

    );

_TRANSPORT_LAY_UNKNOWN_XML_XML_BAD_ELEM_BAD_XML = ‐319_DATA_LINK_LAYE_DATA_LINK_LAYET_END_ sult_t; 

YER_UNKNOWN_TL_TAG = ‐317, 

MENT = ‐318, 9, ER_MISSING_DSAER_MISSING_SSAP

TAG = ‐316, 

P = ‐320, P = ‐321, 

se_from_etth 

gsse_f

S  gsse_r

( _IN_  c_IN_  c_OUT__OUT_); 

TION  The gsEthernsourceto the GSSE a

VALUE The gsreturn

se_from_xm

gsse_f

S  gsse_r

( _IN_  c_IN_  c_OUT_

 

from_eth ‐ fil

result_t gsse_

const odata_const odata__       odata_s_       gsse_t* 

sse_from_ethnet packet. The_size argumeodata_size_targument poi

sse_from_ethed. 

ml 

from_xml ‐ fil

result_t gsse_

const xml_t* const xml_ele_       gsse_t* 

ls gsse_t stru

_from_eth 

octet_t* sousize_t   sourcize_t*  taken       gsse 

h() function fihe source argent contains tt structure wnts to the gss

h() function re

lls gsse_t stru

_from_xml 

             xml,ement_index            gsse 

cture with da

rce, ce_size, _source_size

lls the gsse_tgument pointsthe source sizhich will holdse_t structure

eturns GSSE_

ucture with d

x_t element_i

GSE 13‐G

ata from the oodata_octet__t structure 

t structure wis to the odataze; the taken_d the number e. 

th an octet aa_octet_t strn_source_sizeof taken inpu

rray from theructure; the e argument pout elements. 

e  

oints  The  

_OK on successs; on error a negative valuue is  

xml_t structuure ata from the 

index, 

Reference Maanual  M‐en 

37 GS‐002‐GSE‐R

 

Page 38: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

  DESCRIPT      

TION  The gsstartinXML_E

sse_from_xmng at the indeELEMENT_RO

ml()  function tx given by th

OOT(0).  

transforms the element_in

he xml_t strucndex argumen

cture into thent, most ofte

e gsse_t strucn being  

cture  

  

E argument pThe xmgsse_t

ml argument  t structure. 

points to thee xml_t structture; the GSS points to the 

 RETURN V   

  

2.14 gss 

NAME   

 SYNOPSIS

      

 DESCRIPT   

    

 RETURN V   

 

   

VALUE The gsreturn

se_to_eth 

gsse_t

S  gsse_r

( _OUT__IN_  c_OUT__IN_  c); 

TION  The gsrepres

The dedestinstructupoints

VALUE The gsreturn

sse_from_xmed. 

to_eth ‐  fills t

result_t gsse_

_       odata_oconst odata__       odata_sconst gsse_t*

sse_to_eth()  sented by the

estination ponation_size arure which wo to the gsse_

sse_from_ethed. 

ml() function r

the odata_oc

_to_eth 

octet_t* destisize_t   destinize_t*  taken*        gsse 

function trane odata_octet

ints to the odrgument. Theould hold the t structure.

h() function re

returns GSSE_

ctet_t structu

ination, nation_size,_destination_

nsforms the gt_t data type.

data_octet_te taken_destinumber of ge

eturns GSSE_

GSE 13‐G

_OK on succe

ure with data 

_size, 

gsse_t structu. 

structure andnation_size penerated octe

_OK on succes

Reference MaGS‐002‐GSE‐R

ss; on error aa negative value is  

from the gsse_t structuree 

ure into an occtet array  

d its size is repoints to the ets. The GSSE

epresented byodata_size_tE argument 

y the t 

ss; on error a negative valuue is  

anual  M‐en 

38 

 

Page 39: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 2.15 gssse_to_xml 

 NAME   

SYNOPSIS

   

         

   

 DESCRIPT               

RETURN V

  2.16 gss

 NAME   

SYNOPSIS

      

 DESCRIPT      

gsse_t

S  odata_

( _IN_  c _OUT_IN_  c

 _IN_   _IN_  ); 

TION  The gsand copointsdestinprinteindent

VALUE The gs

se_to_xml_

gsse_t

S  odata_

( _IN_  c_OUT__IN_  c_IN_  c); 

TION  The gsinto thpoints

to_xml ‐ creat

_size_t gsse_t

const gsse_t*_       char*    const odata_

const int       const int       

sse_to_xml() opies it to the to the gsse_nation_size byd before evert. 

sse_to_xml() 

_file 

to_xml_file ‐ 

_size_t gsse_t

const gsse_t*_       FILE*   ficonst int     deconst int     de

sse_to_xml_fhe file.  The gs to the FILE st

tes strings wi

to_xml 

*      gsse,     destinationsize_t destina

   depth,    depth_step

creates stringe buffer pointt structure. Tytes. The depry new line an

function retu

writes the xm

to_xml_file

* gsse, le, epth, epth_step 

file() functionsse argumenttructure. The

ith the xml re

n, ation_size, 

gs with the xmed to by the dThis function dpth argument nd the depth_

urns the numb

ml representa

 writes the xmt points to thee depth argum

GSE 13‐G

epresentationn of the gsse__t structure 

ml representadestination adoes not writcontains the_step is a num

ation of the gargument. Thte more than  number of lember of spac

gsse_t structue gsse argumthe  eading spaceses realized by

ure  ment  

s  y the  

ber of writtenn xml charactters. 

e ation of the gssse_t structure into the fil

ml representae gsse_t strucment contains

ation of the gcture and thes the number

gsse_t structue file argumenr of leading sp

ure  nt  paces  

Reference Maanual  M‐en 

39 GS‐002‐GSE‐R

 

Page 40: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 printerealize

      

d before eached by indent. 

h line and thee depth_step argument coontains the nuumber of spacces  

RETURN V

  2.17 gss

 NAME   

SYNOPSIS

   

 DESCRIPT

RETURN V   

 

2.18 gss

 NAME   

 SYNOPSIS

   

 DESCRIPT      

 RETURN V

 

VALUE The gs

se_validatio

gsse_v

S  gsse_r

( _IN_ c); 

TION  This fu

VALUE The gsreturn

se_get_resu

gsse_g

S  const c

( _IN_ c); 

TION  The  gsdescripgsse_r

VALUE The gs

sse_to_xml_f

on 

validation ‐ va

result_t gsse_

const gsse_t* 

unction valida

sse_validationed. 

ult_string 

get_result_st

char* gsse_g

const gsse_re

sse_get_resuption. The coresult_t struc

sse_get_resul

file() function

alidates fields

_validation 

gsse 

ates fields in t

n() function r

ring ‐ returns

et_result_str

sult_t code

ult_string()  fude argumentcture. 

lt_string()  re

 returns the n

s in the gsse_

the gsse_t str

returns GSSE_

s string descri

ring 

unction  returt contains ret

eturns a string

GSE 13‐G

number of wrritten charactters. 

_t structure

ructure point

_OK on succe

ibing the resu

rns a pointer urned code o

g with the cod

Reference MaGS‐002‐GSE‐R

ed by the GSSSE argument.. 

ss; on error aa negative value is  

ulting code 

to a string wiof the GSSE fu

ith a code  unction and itts  

de descriptionn. 

anual  M‐en 

40 

 

Page 41: GSE GOOSE/GSSE Reference Manual - gridsoftware.com

 

 

2.19 gss

 NAME   

SYNOPSIS

   

 DESCRIPT   

RETURN V

 

se_init 

goose_

S  void gs

( _OUT_); 

TION  The gsgsse_t

VALUE The gs

_init ‐ initializ

sse_init 

_ gsse_t* gsse

sse_init() funct structure. 

sse_init() fun

zes the gsse_

ction initialize

ction does no

t structure 

es the gsse_t

ot return any 

GSE 13‐G

structure. Th

value. 

Reference MaGS‐002‐GSE‐R

he GSSE argum

anual  M‐en 

ment points t

 

41 

to the