/usr/include/yuma/agt/agt_ses.h is in libyuma-dev 2.10-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef _H_agt_ses
#define _H_agt_ses
/* FILE: agt_ses.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
NETCONF Session Server definitions module
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
06-jun-06 abb Begun.
*/
#include <sys/select.h>
#include <xmlstring.h>
#ifndef _H_getcb
#include "getcb.h"
#endif
#ifndef _H_ncxconst
#include "ncxconst.h"
#endif
#ifndef _H_ses
#include "ses.h"
#endif
#ifndef _H_status
#include "status.h"
#endif
#ifndef _H_val
#include "val.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* C O N S T A N T S *
* *
*********************************************************************/
/********************************************************************
* *
* T Y P E S *
* *
*********************************************************************/
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION agt_ses_init
*
* INIT 1:
* Initialize the session manager module data structures
*
* INPUTS:
* none
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_init (void);
/********************************************************************
* FUNCTION agt_ses_cleanup
*
* Cleanup the session manager module data structures
*
* INPUTS:
* none
* RETURNS:
* none
*********************************************************************/
extern void
agt_ses_cleanup (void);
/********************************************************************
* FUNCTION agt_ses_new_dummy_session
*
* Create a dummy session control block
*
* INPUTS:
* none
* RETURNS:
* pointer to initialized dummy SCB, or NULL if malloc error
*********************************************************************/
extern ses_cb_t *
agt_ses_new_dummy_session (void);
/********************************************************************
* FUNCTION agt_ses_set_dummy_session_acm
*
* Set the session ID and username of the user that
* will be responsible for the rollback if needed
*
* INPUTS:
* dummy_session == session control block to change
* use_sid == Session ID to use for the rollback
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_set_dummy_session_acm (ses_cb_t *dummy_session,
ses_id_t use_sid);
/********************************************************************
* FUNCTION agt_ses_free_dummy_session
*
* Free a dummy session control block
*
* INPUTS:
* scb == session control block to free
*
*********************************************************************/
extern void
agt_ses_free_dummy_session (ses_cb_t *scb);
/********************************************************************
* FUNCTION agt_ses_new_session
*
* Create a real server session control block
*
* INPUTS:
* transport == the transport type
* fd == file descriptor number to use for IO
* RETURNS:
* pointer to initialized SCB, or NULL if some error
* This pointer is stored in the session table, so it does
* not have to be saved by the caller
*********************************************************************/
extern ses_cb_t *
agt_ses_new_session (ses_transport_t transport,
int fd);
/********************************************************************
* FUNCTION agt_ses_free_session
*
* Free a real session control block
*
* INPUTS:
* scb == session control block to free
*
*********************************************************************/
extern void
agt_ses_free_session (ses_cb_t *scb);
/********************************************************************
* FUNCTION agt_ses_session_id_valid
*
* Check if a session-id is for an active session
*
* INPUTS:
* sid == session ID to check
* RETURNS:
* TRUE if active session; FALSE otherwise
*********************************************************************/
extern boolean
agt_ses_session_id_valid (ses_id_t sid);
/********************************************************************
* FUNCTION agt_ses_request_close
*
* Start the close of the specified session
*
* INPUTS:
* scb == the session to close
* killedby == session ID executing the kill-session or close-session
* termreason == termination reason code
*
* RETURNS:
* none
*********************************************************************/
extern void
agt_ses_request_close (ses_cb_t *scb,
ses_id_t killedby,
ses_term_reason_t termreason);
/********************************************************************
* FUNCTION agt_ses_kill_session
*
* Kill the specified session
*
* INPUTS:
* scb == the session to close
* killedby == session ID executing the kill-session or close-session
* termreason == termination reason code
*
* RETURNS:
* none
*********************************************************************/
extern void
agt_ses_kill_session (ses_cb_t *scb,
ses_id_t killedby,
ses_term_reason_t termreason);
/********************************************************************
* FUNCTION agt_ses_process_first_ready
*
* Check the readyQ and process the first message, if any
*
* RETURNS:
* TRUE if a message was processed
* FALSE if the readyQ was empty
*********************************************************************/
extern boolean
agt_ses_process_first_ready (void);
/********************************************************************
* FUNCTION agt_ses_check_timeouts
*
* Check if any sessions need to be dropped because they
* have been idle too long.
*
*********************************************************************/
extern void
agt_ses_check_timeouts (void);
/********************************************************************
* FUNCTION agt_ses_ssh_port_allowed
*
* Check if the port number used for SSH connect is okay
*
* RETURNS:
* TRUE if port allowed
* FALSE if port not allowed
*********************************************************************/
extern boolean
agt_ses_ssh_port_allowed (uint16 port);
/********************************************************************
* FUNCTION agt_ses_fill_writeset
*
* Drain the ses_msg outreadyQ and set the specified fdset
* Used by agt_ncxserver write_fd_set
*
* INPUTS:
* fdset == pointer to fd_set to fill
* maxfdnum == pointer to max fd int to fill in
*
* OUTPUTS:
* *fdset is updated in
* *maxfdnum may be updated
*********************************************************************/
extern void
agt_ses_fill_writeset (fd_set *fdset,
int *maxfdnum);
/********************************************************************
* FUNCTION agt_ses_get_inSessions
*
* <get> operation handler for the inSessions counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_inSessions (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_inBadHellos
*
* <get> operation handler for the inBadHellos counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_inBadHellos (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_inRpcs
*
* <get> operation handler for the inRpcs counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_inRpcs (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_inBadRpcs
*
* <get> operation handler for the inBadRpcs counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_inBadRpcs (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_outRpcErrors
*
* <get> operation handler for the outRpcErrors counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_outRpcErrors (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_outNotifications
*
* <get> operation handler for the outNotifications counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_outNotifications (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_droppedSessions
*
* <get> operation handler for the droppedSessions counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_droppedSessions (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_session_inRpcs
*
* <get> operation handler for the session/inRpcs counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_session_inRpcs (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_session_inBadRpcs
*
* <get> operation handler for the inBadRpcs counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_session_inBadRpcs (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_session_outRpcErrors
*
* <get> operation handler for the outRpcErrors counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_session_outRpcErrors (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_get_session_outNotifications
*
* <get> operation handler for the outNotifications counter
*
* INPUTS:
* see ncx/getcb.h getcb_fn_t for details
*
* RETURNS:
* status
*********************************************************************/
extern status_t
agt_ses_get_session_outNotifications (ses_cb_t *scb,
getcb_mode_t cbmode,
const val_value_t *virval,
val_value_t *dstval);
/********************************************************************
* FUNCTION agt_ses_invalidate_session_acm_caches
*
* Invalidate all session ACM caches so they will be rebuilt
* TBD:: optimize and figure out exactly what needs to change
*
*********************************************************************/
extern void
agt_ses_invalidate_session_acm_caches (void);
/********************************************************************
* FUNCTION agt_ses_get_session_for_id
*
* get the session for the supplied sid
*
* INPUTS:
* ses_id_t the id of the session to get
*
* RETURNS:
* ses_cb_t* or NULL
*
*********************************************************************/
extern ses_cb_t*
agt_ses_get_session_for_id(ses_id_t sid);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_agt_ses */
|