}
/**
- * @param taskContext
- * @param input
- * @param cookie
+ * @param taskContext task context
+ * @param input flow object input
+ * @param cookie switch connection distinguisher cookie value
* @return UpdateFlow task
*/
public static OFRpcTask<AddFlowInput, RpcResult<UpdateFlowOutput>> createAddFlowTask(
* The next flowmod gets executed if the earlier one is successful.
* All the flowmods should have the same xid, in-order to cross-reference
* the notification
+ * @param taskContext task context
+ * @param ofFlowModInputs list of flow mod as input
+ * @param index starting index
+ * @param cookie switch connection distinguisher
+ * @return listenable future with update flow output
+ *
*/
protected static ListenableFuture<RpcResult<UpdateFlowOutput>> chainFlowMods(
final List<FlowModInputBuilder> ofFlowModInputs, final int index,
/**
- * @param input
- * @return
+ * @param input flow input
+ * @return flow added notification
*/
protected static NotificationComposer<FlowAdded> createFlowAddedNotification(
final AddFlowInput input) {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
+ * @param taskContext task context
+ * @param input update flow input
+ * @param cookie switch connection distinguisher cookie value
+ * @param rwTx read write transaction
* @return UpdateFlow task
*/
public static OFRpcTask<UpdateFlowInput, RpcResult<UpdateFlowOutput>> createUpdateFlowTask(
/**
- * @param input
- * @return
+ * @param input update flow input
+ * @return flow update notification
*/
protected static NotificationComposer<FlowUpdated> createFlowUpdatedNotification(final UpdateFlowInput input) {
return new NotificationComposer<FlowUpdated>() {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
+ * @param taskContext taks context
+ * @param input group update input
+ * @param cookie switch connection distinguisher cookie value
* @return update group task
*/
public static OFRpcTask<AddGroupInput, RpcResult<UpdateGroupOutput>> createAddGroupTask(
/**
- * @param input
- * @return
+ * @param input group add input
+ * @return group added notification
*/
protected static NotificationComposer<GroupAdded> createGroupAddedNotification(
final AddGroupInput input) {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
+ * @param taskContext task context
+ * @param input meter add input
+ * @param cookie switch connection distinguisher
* @return update meter task
*/
public static OFRpcTask<AddMeterInput, RpcResult<UpdateMeterOutput>> createAddMeterTask(
}
/**
- * @param input
- * @return
+ * @param input add meter input
+ * @return meter added notification composer
*/
protected static NotificationComposer<MeterAdded> createMeterAddedNotification(
final AddMeterInput input) {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
+ * @param taskContext task context
+ * @param input update group output
+ * @param cookie switch connection distinguisher cookie value
* @return UpdateFlow task
*/
public static OFRpcTask<UpdateGroupInput, RpcResult<UpdateGroupOutput>> createUpdateGroupTask(
}
/**
- * @param input
- * @return
+ * @param input group update input
+ * @return group updated notification composer
*/
protected static NotificationComposer<GroupUpdated> createGroupUpdatedNotification(
final UpdateGroupInput input) {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
+ * @param taskContext task context
+ * @param input update meter input
+ * @param cookie switch connection distinguisher cookie value
* @return update meter task
*/
public static OFRpcTask<UpdateMeterInput, RpcResult<UpdateMeterOutput>> createUpdateMeterTask(
}
/**
- * @param input
- * @return
+ * @param input meter update input
+ * @return meter updated notification
*/
protected static NotificationComposer<MeterUpdated> createMeterUpdatedNotification(
final UpdateMeterInput input) {
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input update flow input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task remove flow task
*/
public static OFRpcTask<RemoveFlowInput, RpcResult<UpdateFlowOutput>> createRemoveFlowTask(
OFRpcTaskContext taskContext, RemoveFlowInput input,
}
/**
- * @param input
- * @return
+ * @param input remove flow input
+ * @return flow removed notification
*/
protected static NotificationComposer<FlowRemoved> createFlowRemovedNotification(
final RemoveFlowInput input) {
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input remove group input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task remove group task
*/
public static OFRpcTask<RemoveGroupInput, RpcResult<UpdateGroupOutput>> createRemoveGroupTask(
final OFRpcTaskContext taskContext, RemoveGroupInput input,
}
/**
- * @param input
- * @return
+ * @param input group remove input
+ * @return group removed notification
*/
protected static NotificationComposer<GroupRemoved> createGroupRemovedNotification(
final RemoveGroupInput input) {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input meter removed input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task meter remove task
*/
public static OFRpcTask<RemoveMeterInput, RpcResult<UpdateMeterOutput>> createRemoveMeterTask(
OFRpcTaskContext taskContext, RemoveMeterInput input,
}
/**
- * @param input
- * @return
+ * @param input remove meter input
+ * @return meter removed notification composer
*/
protected static NotificationComposer<MeterRemoved> createMeterRemovedNotification(
final RemoveMeterInput input) {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get all statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get all group statistics task
*/
public static OFRpcTask<GetAllGroupStatisticsInput, RpcResult<GetAllGroupStatisticsOutput>> createGetAllGroupStatisticsTask(
final OFRpcTaskContext taskContext, GetAllGroupStatisticsInput input,
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get group description input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get group description task
*/
public static OFRpcTask<GetGroupDescriptionInput, RpcResult<GetGroupDescriptionOutput>> createGetGroupDescriptionTask(
final OFRpcTaskContext taskContext, GetGroupDescriptionInput input,
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get group feature input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get group feature task
*/
public static OFRpcTask<GetGroupFeaturesInput, RpcResult<GetGroupFeaturesOutput>> createGetGroupFeaturesTask(
final OFRpcTaskContext taskContext, GetGroupFeaturesInput input,
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get group statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get group statistics task
*/
public static OFRpcTask<GetGroupStatisticsInput, RpcResult<GetGroupStatisticsOutput>> createGetGroupStatisticsTask(
final OFRpcTaskContext taskContext, final GetGroupStatisticsInput input,
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get meter config statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get all mtere config statistics task
*/
public static OFRpcTask<GetAllMeterConfigStatisticsInput, RpcResult<GetAllMeterConfigStatisticsOutput>> createGetAllMeterConfigStatisticsTask(
final OFRpcTaskContext taskContext, final GetAllMeterConfigStatisticsInput input,
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get all meter statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get all meter statistics task
*/
public static OFRpcTask<GetAllMeterStatisticsInput, RpcResult<GetAllMeterStatisticsOutput>> createGetAllMeterStatisticsTask(
final OFRpcTaskContext taskContext, final GetAllMeterStatisticsInput input,
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get meter features input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get meter feature task
*/
public static OFRpcTask<GetMeterFeaturesInput, RpcResult<GetMeterFeaturesOutput>> createGetMeterFeaturesTask(
final OFRpcTaskContext taskContext, final GetMeterFeaturesInput input,
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get meter statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get meter statistics task
*/
public static OFRpcTask<GetMeterStatisticsInput, RpcResult<GetMeterStatisticsOutput>> createGetMeterStatisticsTask(
final OFRpcTaskContext taskContext, final GetMeterStatisticsInput input,
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get all node connector statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get all node connector statistics task
*/
public static OFRpcTask<GetAllNodeConnectorsStatisticsInput, RpcResult<GetAllNodeConnectorsStatisticsOutput>>
createGetAllNodeConnectorsStatisticsTask(
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get node connector statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get node connector statistics task
*/
public static OFRpcTask<GetNodeConnectorStatisticsInput, RpcResult<GetNodeConnectorStatisticsOutput>>
createGetNodeConnectorStatisticsTask(
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get all flow statistics from flow table
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get all flow statistics from flow table task
*/
public static OFRpcTask<GetAllFlowStatisticsFromFlowTableInput, RpcResult<GetAllFlowStatisticsFromFlowTableOutput>>
createGetAllFlowStatisticsFromFlowTableTask(
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get all flow statistics from all flow table
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get all flow statistics from all flow table task
*/
public static OFRpcTask<GetAllFlowsStatisticsFromAllFlowTablesInput, RpcResult<GetAllFlowsStatisticsFromAllFlowTablesOutput>>
createGetAllFlowsStatisticsFromAllFlowTablesTask(
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get flow statistics from flow table
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get flow statistics from flow table task
*/
public static OFRpcTask<GetFlowStatisticsFromFlowTableInput, RpcResult<GetFlowStatisticsFromFlowTableOutput>>
createGetFlowStatisticsFromFlowTableTask(
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input get aggregate flow statistics from flow table for all flow input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task get aggregate flow stats from flow table for all flow task
*/
public static OFRpcTask<GetAggregateFlowStatisticsFromFlowTableForAllFlowsInput, RpcResult<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput>>
createGetAggregateFlowStatisticsFromFlowTableForAllFlowsTask(
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input aggregate flow statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task task to fetch the statistics
*/
public static OFRpcTask<GetAggregateFlowStatisticsFromFlowTableForGivenMatchInput, RpcResult<GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutput>>
createGetAggregateFlowStatisticsFromFlowTableForGivenMatchTask(
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input flow table statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task task to fetch table statistics
*/
public static OFRpcTask<GetFlowTablesStatisticsInput, RpcResult<GetFlowTablesStatisticsOutput>> createGetFlowTablesStatisticsTask(
final OFRpcTaskContext taskContext, final GetFlowTablesStatisticsInput input, SwitchConnectionDistinguisher cookie) {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input queue statistics input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task task to fetch all queue statistics
*/
public static OFRpcTask<GetAllQueuesStatisticsFromAllPortsInput, RpcResult<GetAllQueuesStatisticsFromAllPortsOutput>> createGetAllQueuesStatisticsFromAllPortsTask(
final OFRpcTaskContext taskContext, final GetAllQueuesStatisticsFromAllPortsInput input, SwitchConnectionDistinguisher cookie) {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input queue statist from specific port input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task task to get queue statistics from specific port
*/
public static OFRpcTask<GetAllQueuesStatisticsFromGivenPortInput, RpcResult<GetAllQueuesStatisticsFromGivenPortOutput>> createGetAllQueuesStatisticsFromGivenPortTask(
final OFRpcTaskContext taskContext, final GetAllQueuesStatisticsFromGivenPortInput input, SwitchConnectionDistinguisher cookie) {
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input queue statistics from given port
+ * @param cookie switch connection distinguisher cookie value
+ * @return task task to get queue statistics from given port
*/
public static OFRpcTask<GetQueueStatisticsFromGivenPortInput, RpcResult<GetQueueStatisticsFromGivenPortOutput>> createGetQueueStatisticsFromGivenPortTask(
final OFRpcTaskContext taskContext, final GetQueueStatisticsFromGivenPortInput input, SwitchConnectionDistinguisher cookie) {
private SettableFuture<RpcResult<T>> result;
/**
- * @param result
+ * @param result result
*/
public ResultCallback(SettableFuture<RpcResult<T>> result) {
this.result = result;
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input update port input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task task to update port
*/
public static OFRpcTask<UpdatePortInput, RpcResult<UpdatePortOutput>> createUpdatePortTask(
final OFRpcTaskContext taskContext, final UpdatePortInput input,
}
/**
- * @param taskContext
- * @param input
- * @param cookie
- * @return task
+ * @param taskContext task context
+ * @param input update table input
+ * @param cookie switch connection distinguisher cookie value
+ * @return task task to udpate table input
*/
public static OFRpcTask<UpdateTableInput, RpcResult<UpdateTableOutput>> createUpdateTableTask(
final OFRpcTaskContext taskContext, final UpdateTableInput input,