aboutsummaryrefslogtreecommitdiffstats
path: root/sualibrary/sua/sua_distribution.h
blob: 6a62f50e9896535892237d45d8300154dc15c070 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/***************************************************************************
                          sua_distribution.h  -  description
                             -------------------
    begin                : Tue Jan 8 2002
    copyright            : (C) 2002 by Lode Coene
    email                : lode.coene@siemens.atea.be
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
/*
 *  $Id: sua_distribution.h,v 1.2 2002/10/15 14:53:48 p82609 Exp $
 *
 * SUA implementation according to SUA draft issue 6.
 *
 * Author(s): Lode Coene
 *            
 *
 * Copyright (C) 2001 by Siemens Atea, Herentals, Belgium.
 *
 * Realized in co-operation between Siemens Atea and 
 * Siemens AG, Munich, Germany.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Contact: gery.verwimp@siemens.atea.be
 *          lode.coene@siemens.atea.be
 *
 * The alternative comment
 * inspiration : Dorine
 * "When B.B. releases one of his pearls of wisedom and "
 * "starts one of his walks around the block, then this designer says:"
 * "I am getting tired of running in circles even if it is "
 * "a nice block in a nice neighbourhood(maybe his walks are recursive)"
 * 
 * Purpose: This header-file defines the SUA distributor functions for:
 *          - Data arrive notification(from SCTP) -> receive the msg data 
 *            from SCTP(use receive_sua_primitive function below), process it 
 *            and call the aproriate SUA msg handling function
 *          - Network status change Notification(from SCTP)
 *          - Sent Failure Notification(from SCTP)
 *          - Communication Lost Notification(from SCTP)
 *          - Communication Up Notification(from SCTP)
 *          - Communication Error Notification(from SCTP)
 *          - Restart Notification(from SCTP)
 *          - Shutdown Notification(from SCTP)
 *          - Send a SUA primitive -> generate and send the msg to SCTP
 *          - Receive the sua "primitive"/msg data from SCTP     
 */


#ifndef SUA_DISTRIBUTION_H
#define SUA_DISTRIBUTION_H


#include "sua.h"
#include <string>


using namespace std;

typedef struct {
  unsigned int   primitive;
  unsigned int   user_ref;
  sccp_QOS_str   QOS;
  sccp_addr_str  called_pty_address;
  sccp_addr_str  calling_pty_address;
  string  userdata;
} sua_save_str;

/***********************************************************************/
/* sctp_DataArriveNotif                                                */
/***********************************************************************/
void sctp_DataArriveNotif( unsigned int   assoc_id,
			   unsigned int   stream_id,
			   unsigned int   len,
			   unsigned short streamSN,
			   unsigned int   tsn,
			   unsigned int   protocol_id,
			   unsigned int   unordered_flag,
			   void *         ulp_data_ptr
			 );


/***********************************************************************/
/* sctp_NetworkStatusChangeNotif                                       */
/***********************************************************************/
void sctp_NetworkStatusChangeNotif( unsigned int   assoc_id,
				    short          dest_addr_index,
				    unsigned short new_path_state,
				    void *         ulp_data_ptr
				  );


/***********************************************************************/
/* sctp_SentFailureNotif                                               */
/***********************************************************************/
void sctp_SentFailureNotif( unsigned int    assoc_id,
			    unsigned char * unsent_data_sent_ptr,
			    unsigned int    len,
			    unsigned int *  sctp_send_context_ptr,
			    void *          ulp_data_ptr
			  );


/***********************************************************************/
/* sctp_communicationLostNotif                                         */
/***********************************************************************/
void sctp_CommunicationLostNotif( unsigned int   assoc_id,
				  unsigned short status_event,
				  void *         ulp_data_ptr 
				);

/***********************************************************************/
/* sctp_CommunicationUpNotif                                           */
/***********************************************************************/
void* sctp_CommunicationUpNotif( unsigned int      assoc_id,
				 int               status_event,
				 unsigned int      nr_of_dest_addr,
				 unsigned short    nr_of_input_streams,
				 unsigned short    nr_of_output_streams,
				 int               support_PRsctp,
				 void *            ulp_data_ptr 
			       );


/***********************************************************************/
/* sctp_CommunicationErrorNotif                                        */
/***********************************************************************/
void sctp_CommunicationErrorNotif( unsigned int   assoc_id,
				   unsigned short error_status,
				   void *         ulp_data_ptr
				 );


/***********************************************************************/
/* sctp_RestartNotif                                                   */
/***********************************************************************/
void sctp_RestartNotif( unsigned int   assoc_id,
			void *         ulp_data_ptr
		      );


/***********************************************************************/
/* sctp_ShutDownCompleteNotif                                       */
/***********************************************************************/
void sctp_ShutDownCompleteNotif( unsigned int   assoc_id,
				 void *         ulp_data_ptr
			       );

#endif  // SUA_DISTRIBUTION_H		  

// end of module sua_distribution.h