peer.h File Reference

---

Detailed Description

CDiameterPeer Peer related functionality.

Author:

Dragos Vingarzan vingarzan -at- fokus dot fraunhofer dot de

Definition in file peer.h.

#include "utils.h"
#include "config.h"
#include <sys/types.h>

Go to the source code of this file.

Data Structures
struct	_peer_t
	Peer data structure. More...
Typedefs
typedef _peer_t	peer
	Peer data structure.
Enumerations
enum	peer_state_t {   Closed = 0, Wait_Conn_Ack = 1, Wait_I_CEA = 2, Wait_Conn_Ack_Elect = 3,   Wait_Returns = 4, R_Open = 5, I_Open = 6, Closing = 7 }
	Peer states definition. More...
enum	peer_event_t {   Start = 101, Stop = 102, Timeout = 103, Win_Election = 104,   R_Conn_CER = 105, I_Rcv_Conn_Ack = 106, I_Rcv_Conn_NAck = 107, I_Rcv_CER = 108,   I_Rcv_CEA = 109, R_Rcv_CER = 110, R_Rcv_CEA = 111, I_Rcv_Non_CEA = 112,   I_Rcv_DPR = 113, I_Rcv_DPA = 114, R_Rcv_DPR = 115, R_Rcv_DPA = 116,   I_Rcv_DWR = 117, I_Rcv_DWA = 118, R_Rcv_DWR = 119, R_Rcv_DWA = 120,   Send_Message = 121, I_Rcv_Message = 122, R_Rcv_Message = 123, I_Peer_Disc = 124,   R_Peer_Disc = 125 }
	Peer events definition. More...
Functions
peer *	new_peer (str fqdn, str realm, int port)
	Create a new peer.
void	free_peer (peer *x, int locked)
	Frees the memory taken by a peer structure.
void	touch_peer (peer *p)
	"Touches" the peer by updating the last activity time to the current time.

---

Typedef Documentation

typedef struct _peer_t peer

Peer data structure.

---

Enumeration Type Documentation

enum peer_state_t

Peer states definition.

Enumerator:

Closed	Not connected.
Wait_Conn_Ack	Connecting - waiting for Ack.
Wait_I_CEA	Connecting - waiting for Capabilities Exchange Answer.
Wait_Conn_Ack_Elect	Connecting - Acknolegded and going for Election.
Wait_Returns	Connecting - done.
R_Open	Connected as receiver.
I_Open	Connected as initiator.
Closing	Closing the connection.

Definition at line 67 of file peer.h.

             {
    Closed              = 0,    
    Wait_Conn_Ack       = 1,    
    Wait_I_CEA          = 2,    
    Wait_Conn_Ack_Elect = 3,    
    Wait_Returns        = 4,    
    R_Open              = 5,    
    I_Open              = 6,    
    Closing             = 7     
} peer_state_t;

enum peer_event_t

Peer events definition.

Enumerator:

Start	Start connection attempt.
Stop	Stop.
Timeout	Time-out.
Win_Election	Winning the election.
R_Conn_CER	Receiver - Received connection Capabilities Exchange Request.
I_Rcv_Conn_Ack	Initiator - Received connection Ack.
I_Rcv_Conn_NAck	Initiator - Received connection NAck.
I_Rcv_CER	Initiator - Receiver Capabilities Exchange Request.
I_Rcv_CEA	Initiator - Receiver Capabilities Exchange Answer.
R_Rcv_CER	Receiver - Receiver Capabilities Exchange Request.
R_Rcv_CEA	Receiver - Receiver Capabilities Exchange Answer.
I_Rcv_Non_CEA	Initiator - Received non-Capabilities Exchange Answer.
I_Rcv_DPR	Initiator - Received Disconnect Peer Request.
I_Rcv_DPA	Initiator - Received Disconnect Peer Answer.
R_Rcv_DPR	Receiver - Received Disconnect Peer Request.
R_Rcv_DPA	Receiver - Received Disconnect Peer Answer.
I_Rcv_DWR	Initiator - Received Diameter Watch-dog Request.
I_Rcv_DWA	Initiator - Received Diameter Watch-dog Answer.
R_Rcv_DWR	Receiver - Received Diameter Watch-dog Request.
R_Rcv_DWA	Receiver - Received Diameter Watch-dog Answer.
Send_Message	Send a message.
I_Rcv_Message	Initiator - Received a message.
R_Rcv_Message	Receiver - Received a message.
I_Peer_Disc	Initiator - Peer disconnected.
R_Peer_Disc	Receiver - Peer disconnected.

Definition at line 80 of file peer.h.

             {
    Start           = 101,  
    Stop            = 102,  
    Timeout         = 103,  
    Win_Election    = 104,  
    R_Conn_CER      = 105,  
    I_Rcv_Conn_Ack  = 106,  
    I_Rcv_Conn_NAck = 107,  
    I_Rcv_CER       = 108,  
    I_Rcv_CEA       = 109,  
    R_Rcv_CER       = 110,  
    R_Rcv_CEA       = 111,  
    I_Rcv_Non_CEA   = 112,  
    I_Rcv_DPR       = 113,  
    I_Rcv_DPA       = 114,  
    R_Rcv_DPR       = 115,  
    R_Rcv_DPA       = 116,  
    I_Rcv_DWR       = 117,  
    I_Rcv_DWA       = 118,  
    R_Rcv_DWR       = 119,  
    R_Rcv_DWA       = 120,  
    Send_Message    = 121,  
    I_Rcv_Message   = 122,  
    R_Rcv_Message   = 123,  
    I_Peer_Disc     = 124,  
    R_Peer_Disc     = 125   
} peer_event_t;

---

Function Documentation

peer* new_peer	(	str	fqdn,
		str	realm,
		int	port
	)

Create a new peer.

• All the memory from parameters is duplicated.

  Parameters:

  	fqdn	- FQDN of the peer
  	realm	- Realm of the peer
  	port	- port of the peer to connect to

  Returns:

  the new peer* if ok, NULL on error

Definition at line 68 of file peer.c.

References _peer_t::activity, Closed, _peer_t::fqdn, _peer_t::I_sock, _peer_t::lock, LOG_NO_MEM, _peer_t::next, _peer_t::port, _peer_t::prev, _peer_t::R_sock, _peer_t::realm, shm_str_dup, and _peer_t::state.

Referenced by get_peer_from_fqdn(), and peer_manager_init().

{
    peer *x;
    x = shm_malloc(sizeof(peer));
    if (!x){
        LOG_NO_MEM("shm",sizeof(peer));
        goto error;
    }
    memset(x,0,sizeof(peer));
    shm_str_dup(x->fqdn,fqdn);
    if (!x->fqdn.s) goto error; 
    shm_str_dup(x->realm,realm);
    if (!x->realm.s) goto error;    
    x->port = port;
    x->lock = lock_alloc();
    x->lock = lock_init(x->lock);
        
    x->state = Closed;

    x->I_sock = -1;
    x->R_sock = -1;

    x->activity = time(0)-500;  
    
    x->next = 0;
    x->prev = 0;
    
    return x;
error:
    return 0;
}

void free_peer	(	peer *	x,
		int	locked
	)

Frees the memory taken by a peer structure.

Parameters:

	x	- the peer to free
	locked	- if the caller of this function already acquired the lock on this peer

Definition at line 105 of file peer.c.

References _peer_t::fqdn, _peer_t::lock, and _peer_t::realm.

Referenced by peer_manager_destroy(), and peer_timer().

{
    if (!x) return;
    if (!locked) lock_get(x->lock);
    if (x->fqdn.s) shm_free(x->fqdn.s);
    if (x->realm.s) shm_free(x->realm.s);   
    lock_destroy(x->lock);
    lock_dealloc((void*)x->lock);
    shm_free(x);
}

void touch_peer

(

peer *

p

)

[inline]

"Touches" the peer by updating the last activity time to the current time.

Parameters:

p

- which peer to touch

Definition at line 120 of file peer.c.

References _peer_t::activity.

Referenced by get_peer_from_fqdn(), peer_timer(), R_Accept(), receive_message(), and Snd_Message().

{
    p->activity = time(0);
}

---