#429: complete exchange on send errors.

Extract CleanupMessageObserver from ExchangeCleanupLayer and add CON
response to cleanup into it. Add also a CleanupMessageObserver to
blockwise notifies in BlockwiseLayer.

Signed-off-by: Achim Kraus <[email protected]>

Author: Achim Kraus

californium-core/src/main/java/org/eclipse/californium/core/network/stack/BlockwiseLayer.java

@@ -889,6 +889,9 @@ private void handleBlock2Response(final Exchange exchange, final Response respon
 					 */
 					if (!response.isNotification()) {
 						block.setToken(response.getToken());
+					} else if (exchange.isNotification()) {
+						// Recreate cleanup message observer 
+						request.addMessageObserver(new CleanupMessageObserver(exchange));
 					}
 
 					// copy options
@@ -904,6 +907,7 @@ private void handleBlock2Response(final Exchange exchange, final Response respon
 					// add an observer that cleans up the block2 transfer tracker if the
 					// block request fails
 					addBlock2CleanUpObserver(block, key, status);
+					
 
 					status.setCurrentNum(nextNum);
 

californium-core/src/main/java/org/eclipse/californium/core/network/stack/CleanupMessageObserver.java

@@ -0,0 +1,61 @@
+/*******************************************************************************
+ * Copyright (c) 2018 Bosch Software Innovations GmbH and others.
+ * 
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ * 
+ * The Eclipse Public License is available at
+ *    http://www.eclipse.org/legal/epl-v10.html
+ * and the Eclipse Distribution License is available at
+ *    http://www.eclipse.org/org/documents/edl-v10.html.
+ * 
+ * Contributors:
+ *    Bosch Software Innovations GmbH - initial creation
+ *                                      extracted from ExchangeCleanupLayer
+ ******************************************************************************/
+package org.eclipse.californium.core.network.stack;
+
+import org.eclipse.californium.core.coap.MessageObserverAdapter;
+import org.eclipse.californium.core.coap.Request;
+import org.eclipse.californium.core.coap.Response;
+import org.eclipse.californium.core.network.Exchange;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Cleanup exchange when user cancelled outgoing requests or messages which
+ * failed to be send.
+ */
+class CleanupMessageObserver extends MessageObserverAdapter {
+
+	static final Logger LOGGER = LoggerFactory.getLogger(CleanupMessageObserver.class.getName());
+
+	private final Exchange exchange;
+
+	CleanupMessageObserver(final Exchange exchange) {
+		this.exchange = exchange;
+	}
+
+	@Override
+	public void onCancel() {
+		complete("canceled");
+	}
+
+	@Override
+	public void failed() {
+		complete("failed");
+	}
+
+	private void complete(final String action) {
+		if (exchange.executeComplete()) {
+			if (exchange.isOfLocalOrigin()) {
+				Request request = exchange.getCurrentRequest();
+				LOGGER.debug("{}, {} request [MID={}, {}]", action, exchange, request.getMID(), request.getToken());
+			} else {
+				Response response = exchange.getCurrentResponse();
+				LOGGER.debug("{}, {} response [MID={}, {}]", action, exchange, response.getMID(), response.getToken());
+			}
+		}
+	}
+}

californium-core/src/main/java/org/eclipse/californium/core/network/stack/ExchangeCleanupLayer.java

@@ -16,47 +16,49 @@
  ******************************************************************************/
 package org.eclipse.californium.core.network.stack;
 
-import org.eclipse.californium.core.coap.MessageObserverAdapter;
 import org.eclipse.californium.core.coap.Request;
+import org.eclipse.californium.core.coap.Response;
 import org.eclipse.californium.core.network.Exchange;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * A layer that reacts to user cancelled outgoing requests, and completes exchange, which causes state clean up.
+ * A layer that reacts to user cancelled outgoing requests or messages which
+ * failed to be send, and completes exchange, which causes state clean up.
  */
 public class ExchangeCleanupLayer extends AbstractLayer {
 
-	private static final Logger LOGGER = LoggerFactory.getLogger(ExchangeCleanupLayer.class.getName());
+	static final Logger LOGGER = LoggerFactory.getLogger(ExchangeCleanupLayer.class.getName());
 
 	/**
-	 * Adds a message observer to the request to be sent which
-	 * completes the exchange if the request gets canceled.
+	 * Adds a message observer to the request to be sent which completes the
+	 * exchange if the request gets canceled or failed.
 	 * 
-	 * @param exchange The (locally originating) exchange that the request is part of.
+	 * @param exchange The (locally originating) exchange that the request is
+	 *            part of.
 	 * @param request The outbound request.
 	 */
 	@Override
 	public void sendRequest(final Exchange exchange, final Request request) {
 
-		request.addMessageObserver(new CancelledMessageObserver(exchange));
-		lower().sendRequest(exchange, request);
+		request.addMessageObserver(new CleanupMessageObserver(exchange));
+		super.sendRequest(exchange, request);
 	}
 
-	private static class CancelledMessageObserver extends MessageObserverAdapter {
-
-		private final Exchange exchange;
-
-		CancelledMessageObserver(final Exchange exchange) {
-			this.exchange = exchange;
-		}
+	/**
+	 * Adds a message observer to a confirmable response to be sent which
+	 * completes the exchange if the response gets canceled or failed.
+	 * 
+	 * @param exchange The (remotely originating) exchange that the response is
+	 *            part of.
+	 * @param response The outbound response.
+	 */
+	@Override
+	public void sendResponse(final Exchange exchange, final Response response) {
 
-		@Override
-		public void onCancel() {
-			if (exchange.executeComplete()) {
-				LOGGER.debug("{}, canceled request [MID={}, {}]", exchange,
-						exchange.getRequest().getMID(), exchange.getRequest().getToken());
-			}
+		if (response.isConfirmable() && !response.isNotification()) {
+			response.addMessageObserver(new CleanupMessageObserver(exchange));
 		}
+		super.sendResponse(exchange, response);
 	}
 }