Changeset 1473 for pjproject/trunk/pjsip/src/pjsip/sip_transport_tls_ossl.c

Timestamp:

Oct 4, 2007 9:50:36 AM (17 years ago)

Author:

bennylp

Message:

Ticket #95: Keep-alive mechanism for TCP and TLS transports

File:

• pjproject/trunk/pjsip/src/pjsip/sip_transport_tls_ossl.c (modified) (12 diffs)

pjproject/trunk/pjsip/src/pjsip/sip_transport_tls_ossl.c

@@ -167 +167 @@
     SSL                     *ssl;
     pj_bool_t                ssl_shutdown_called;
+
+    /* Keep alive */
+    pj_timer_entry           ka_timer;
+    pj_time_val              last_activity;
 
     /* TLS transport can only have  one rdata!
@@ -742 +746 @@
 
 /* Send outgoing data with SSL connection */
-static pj_status_t ssl_write(struct tls_transport *tls,
-                             pjsip_tx_data *tdata)
-{
-    int size = tdata->buf.cur - tdata->buf.start;
+static pj_status_t ssl_write_bytes(struct tls_transport *tls,
+                                   const void *data,
+                                   int size,
+                                   const char *data_name)
+{
     int sent = 0;
 
     do {
         const int fragment_sent = SSL_write(tls->ssl,
-                                            tdata->buf.start + sent, 
+                                            ((pj_uint8_t*)data) + sent, 
                                             size - sent);
     
@@ -799 +804 @@
             ssl_report_error(tls->base.obj_name, 4, PJ_SUCCESS,
                              "Error sending %s with SSL_write()",
-                             pjsip_tx_data_get_info(tdata));
+                             data_name);
             return pj_get_netos_error() ? pj_get_netos_error() 
                     : PJSIP_TLS_ESEND;
@@ -807 +812 @@
 
     return PJ_SUCCESS;
+
+}
+
+/* Send outgoing tdata with SSL connection */
+static pj_status_t ssl_write(struct tls_transport *tls,
+                             pjsip_tx_data *tdata)
+{
+    return ssl_write_bytes(tls, tdata->buf.start, 
+                           tdata->buf.cur - tdata->buf.start,
+                           pjsip_tx_data_get_info(tdata));
 }
 
@@ -1162 +1177 @@
                                 pj_status_t status);
 
+/* TLS keep-alive timer callback */
+static void tls_keep_alive_timer(pj_timer_heap_t *th, pj_timer_entry *e);
 
 /*
@@ -1204 +1221 @@
 
     /* Initialize transport reference counter to 1 */
-    status = pj_atomic_create(pool, 1, &tls->base.ref_cnt);
+    status = pj_atomic_create(pool, 0, &tls->base.ref_cnt);
     if (status != PJ_SUCCESS) {
         goto on_error;
@@ -1273 +1290 @@
 
     tls->is_registered = PJ_TRUE;
+
+    /* Initialize keep-alive timer */
+    tls->ka_timer.user_data = (void*) tls;
+    tls->ka_timer.cb = &tls_keep_alive_timer;
+
 
     /* Done setting up basic transport. */
@@ -1724 +1746 @@
                                  "Error creating incoming TLS transport");
                 pjsip_transport_shutdown(&tls->base);
+
+            } else {
+                /* Start keep-alive timer */
+                if (PJSIP_TLS_KEEP_ALIVE_INTERVAL) {
+                    pj_time_val delay = {PJSIP_TLS_KEEP_ALIVE_INTERVAL, 0};
+                    pjsip_endpt_schedule_timer(listener->endpt, 
+                                               &tls->ka_timer, 
+                                               &delay);
+                    tls->ka_timer.id = PJ_TRUE;
+                    pj_gettimeofday(&tls->last_activity);
+                }
             }
 
@@ -1775 +1808 @@
         if (tls->close_reason==PJ_SUCCESS) tls->close_reason = status;
         pjsip_transport_shutdown(&tls->base);
+    } else {
+        /* Mark last activity */
+        pj_gettimeofday(&tls->last_activity);
     }
 
@@ -1919 +1955 @@
     /* Shutdown SSL */
     if (!tls->ssl_shutdown_called) {
-        /* Release our reference counter and shutdown SSL */
-        pjsip_transport_dec_ref(transport);
+        /* shutdown SSL */
         SSL_shutdown(tls->ssl);
         tls->ssl_shutdown_called = PJ_TRUE;
@@ -1969 +2004 @@
              */
             pj_size_t size_eaten;
+
+            /* Mark last activity */
+            pj_gettimeofday(&tls->last_activity);
 
             /* Init pkt_info part. */
@@ -2217 +2255 @@
     /* Flush all pending send operations */
     tls_flush_pending_tx(tls);
+
+    /* Start keep-alive timer */
+    if (PJSIP_TLS_KEEP_ALIVE_INTERVAL) {
+        pj_time_val delay = { PJSIP_TLS_KEEP_ALIVE_INTERVAL, 0 };
+        pjsip_endpt_schedule_timer(tls->listener->endpt, &tls->ka_timer, 
+                                   &delay);
+        tls->ka_timer.id = PJ_TRUE;
+        pj_gettimeofday(&tls->last_activity);
+    }
+
+}
+
+
+/* Transport keep-alive timer callback */
+static void tls_keep_alive_timer(pj_timer_heap_t *th, pj_timer_entry *e)
+{
+    struct tls_transport *tls = (struct tls_transport*) e->user_data;
+    const pj_str_t ka_data = PJSIP_TLS_KEEP_ALIVE_DATA;
+    pj_time_val delay;
+    pj_time_val now;
+    pj_status_t status;
+
+    PJ_UNUSED_ARG(th);
+
+    tls->ka_timer.id = PJ_TRUE;
+
+    pj_gettimeofday(&now);
+    PJ_TIME_VAL_SUB(now, tls->last_activity);
+
+    if (now.sec > 0 && now.sec < PJSIP_TLS_KEEP_ALIVE_INTERVAL) {
+        /* There has been activity, so don't send keep-alive */
+        delay.sec = PJSIP_TLS_KEEP_ALIVE_INTERVAL - now.sec;
+        delay.msec = 0;
+
+        pjsip_endpt_schedule_timer(tls->listener->endpt, &tls->ka_timer, 
+                                   &delay);
+        tls->ka_timer.id = PJ_TRUE;
+        return;
+    }
+
+    PJ_LOG(5,(tls->base.obj_name, "Sending %d byte(s) keep-alive to %.*s:%d", 
+              (int)ka_data.slen, (int)tls->base.remote_name.host.slen,
+              tls->base.remote_name.host.ptr,
+              tls->base.remote_name.port));
+
+    /* Send the data */
+    status = ssl_write_bytes(tls, ka_data.ptr, (int)ka_data.slen, 
+                             "keep-alive");
+    if (status != PJ_SUCCESS && 
+        status != PJ_STATUS_FROM_OS(OSERR_EWOULDBLOCK))
+    {
+        ssl_report_error(tls->base.obj_name, 1, status,
+                         "Error sending keep-alive packet");
+        return;
+    }
+
+    /* Register next keep-alive */
+    delay.sec = PJSIP_TLS_KEEP_ALIVE_INTERVAL;
+    delay.msec = 0;
+
+    pjsip_endpt_schedule_timer(tls->listener->endpt, &tls->ka_timer, 
+                               &delay);
+    tls->ka_timer.id = PJ_TRUE;
 }