# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""

Binary protocol to communicate with the Java BSP task via streams.

"""

class BinaryProtocol:
    START = 0
    SET_BSPJOB_CONF = 1
    SET_INPUT_TYPES = 2
    RUN_SETUP = 3
    RUN_BSP = 4
    RUN_CLEANUP = 5
    READ_KEYVALUE = 6
    WRITE_KEYVALUE = 7
    GET_MSG = 8
    GET_MSG_COUNT = 9
    SEND_MSG = 10
    SYNC = 11
    GET_ALL_PEERNAME = 12
    GET_PEERNAME = 13
    GET_PEER_INDEX = 14
    GET_PEER_COUNT = 15
    GET_SUPERSTEP_COUNT = 16
    REOPEN_INPUT = 17
    CLEAR = 18
    CLOSE = 19
    ABORT = 20
    DONE = 21
    TASK_DONE = 22
    REGISTER_COUNTER = 23
    INCREMENT_COUNTER = 24
    SEQFILE_OPEN = 25
    SEQFILE_READNEXT = 26
    SEQFILE_APPEND = 27
    SEQFILE_CLOSE = 28
    PARTITION_REQUEST = 29
    PARTITION_RESPONSE = 30
    LOG = 31
    END_OF_DATA = 32

    @staticmethod
    def getProtocolString(opCode):
        return "%" + str(opCode) + "%=";

    @staticmethod
    def getAckProtocolString(opCode):
        return "%ACK_" + str(opCode) + "%=";