github.com/lirm/aeron-go@v0.0.0-20230415210743-920325491dc4/aeron/logbuffer/term/controlledfragmenthandler.go (about)

     1  // Copyright 2016 Stanislav Liberman
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  // http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package term
    16  
    17  import (
    18  	"github.com/lirm/aeron-go/aeron/atomic"
    19  	"github.com/lirm/aeron-go/aeron/logbuffer"
    20  )
    21  
    22  type ControlledFragmentHandler func(
    23  	buffer *atomic.Buffer,
    24  	offset int32,
    25  	length int32,
    26  	header *logbuffer.Header,
    27  ) ControlledPollAction
    28  
    29  type ControlledPollAction int8
    30  
    31  const (
    32  	// ControlledPollActionAbort aborts the current polling operation and do not
    33  	// advance the position for this fragment.
    34  	ControlledPollActionAbort ControlledPollAction = 1
    35  	// ControlledPollActionBreak breaks from the current polling operation and
    36  	// commit the position as of the end of the current fragment being handled.
    37  	ControlledPollActionBreak = 2
    38  	// ControlledPollActionCommit continues processing but commit the position as of
    39  	// the end of the current fragment so that flow control is applied to this
    40  	// point.
    41  	ControlledPollActionCommit = 3
    42  	// ControlledPollActionContinue continues processing until fragment limit or no
    43  	// fragments with position commit at end of poll as in onFragment
    44  	ControlledPollActionContinue = 4
    45  )