/**
* set listener for connection became ready-to-use event
- * @param connectionReadyListener
+ * @param connectionReadyListener listens to connection ready event
*/
void setConnectionReadyListener(ConnectionReadyListener connectionReadyListener);
/**
* sets option for automatic channel reading;
* if set to false, incoming messages won't be read
+ *
+ * @param autoRead target value to be switched to
*/
void setAutoRead(boolean autoRead);
/**
* Registers a new bypass outbound queue
- * @param handler
- * @param maxQueueDepth
- * @param maxBarrierNanos
+ * @param <T> handler type
+ * @param handler queue handler
+ * @param maxQueueDepth max amount of not confirmed messaged in queue (i.e. edge for barrier message)
+ * @param maxBarrierNanos regular base for barrier message
* @return An {@link OutboundQueueHandlerRegistration}
*/
@Beta
* with a response, the object reported will be non-null. If the request's completion
* is implied by a barrier, the object reported will be null.
*
- * If this request fails on the remote device, {@link FutureCallback#onFailure(Throwable)
+ * If this request fails on the remote device, {@link FutureCallback#onFailure(Throwable)}
* will be called with an instance of {@link DeviceRequestFailedException}.
*
- * If the request fails due to local reasons, {@link FutureCallback#onFailure(Throwable)
+ * If the request fails due to local reasons, {@link FutureCallback#onFailure(Throwable)}
* will be called with an instance of {@link OutboundQueueException}. In particular, if
* this request failed because the device disconnected, {@link OutboundQueueException#DEVICE_DISCONNECTED}
* will be reported.
void onSwitchConnected(ConnectionAdapter connection);
/**
- * @param switchAddress
+ * @param switchAddress address of incoming connection (address + port)
* @return true, if connection from switch having given address shell be accepted; false otherwise
*/
boolean accept(InetAddress switchAddress);
void init();
/**
+ * @param <T> type of particular deserializer
* @param key used for deserializer lookup
* @return deserializer found
*/
/**
* Injects deserializer registry into deserializer
- * @param deserializerRegistry
+ * @param deserializerRegistry registry of deserializers
*/
void injectDeserializerRegistry(DeserializerRegistry deserializerRegistry);
}
private final Class<F> msgType2;
/**
- * @param msgVersion
- * @param msgType
- * @param msgType2
+ * @param msgVersion protocol version
+ * @param msgType main type
+ * @param msgType2 subtype
*/
public EnhancedMessageTypeKey(short msgVersion, Class<E> msgType, Class<F> msgType2) {
super(msgVersion, msgType);
package org.opendaylight.openflowjava.protocol.api.extensibility;
import io.netty.buffer.ByteBuf;
-
import org.opendaylight.yangtools.yang.binding.DataObject;
/**
* @author michal.polkorab
- * @param <E>
+ * @param <E> output message type
*/
public interface HeaderDeserializer<E extends DataObject> extends OFGeneralDeserializer {
*/
package org.opendaylight.openflowjava.protocol.api.extensibility;
-import org.opendaylight.yangtools.yang.binding.DataObject;
-
import io.netty.buffer.ByteBuf;
+import org.opendaylight.yangtools.yang.binding.DataObject;
/**
* Does only-header serialization (such as oxm_ids, action_ids, instruction_ids)
* @author michal.polkorab
- * @param <T>
+ * @param <T> input message type
*/
public interface HeaderSerializer<T extends DataObject> extends OFGeneralSerializer {
/**
* Registers match entry serializer
+ * @param <C> oxm type
+ * @param <F> match field type
* @param key used for serializer lookup
* @param serializer serializer implementation
*/
void init();
/**
+ * @param <K> input key type
+ * @param <S> type of resulting serializer
* @param msgTypeKey lookup key
* @return serializer or NullPointerException if no serializer was found
*/
* If the serializer implements {@link SerializerRegistryInjector} interface,
* the serializer is injected with SerializerRegistry instance.
*
+ * @param <K> serializer key type
* @param key used for serializer lookup
* @param serializer serializer implementation
*/
/**
* Unregisters serializer
+ * @param <K> serializer key type
* @param key used for serializer lookup
* @return true if serializer was removed,
* false if no serializer was found under specified key
private Long experimenterId;
/**
+ * @param <E> type of target experimenter object
* @param version protocol wire version
* @param experimenterId experimenter / vendor ID
* @param objectClass class of created object
/**
* @param version protocol wire version
- * @param experimenterId
+ * @param experimenterId experimenter (vendor) identifier
*/
public ExperimenterInstructionDeserializerKey(short version, Long experimenterId) {
super(version, EncodeConstants.EXPERIMENTER_VALUE, experimenterId);
/**
* @param version protocol wire version
* @param type instruction type
- * @param experimenterId
+ * @param experimenterId experimenter (vendor) identifier
*/
public InstructionDeserializerKey(short version, int type,
Long experimenterId) {
}
/**
- * @param value
- * @return int part wrapped in long
+ * @param value input integer value (might be negative)
+ * @return int part wrapped in long (always positive)
*/
public static long intToUnsignedLong(int value) {
return value & 0x00000000ffffffffL;
}
/**
- * @param value
+ * @param value input long value
* @return long cut into int
*/
public static int longToSignedInt(long value) {
Code Review / openflowjava.git / commitdiff