com.moilioncircle.redis.replicator.Replicator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of redis-replicator Show documentation

Redis Replicator implement Redis Replication protocol written in java. It can parse,filter,broadcast the RDB and AOF events in a real time manner. It also can synchronize redis data to your local cache or to database.

There is a newer version: 3.8.1

Show newest version

/*
 * Copyright 2016 leon chen
 *
 * Licensed 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.
 */

package com.moilioncircle.redis.replicator;

import com.moilioncircle.redis.replicator.cmd.Command;
import com.moilioncircle.redis.replicator.cmd.CommandName;
import com.moilioncircle.redis.replicator.cmd.CommandParser;
import com.moilioncircle.redis.replicator.rdb.RdbVisitor;
import com.moilioncircle.redis.replicator.rdb.datatype.Module;
import com.moilioncircle.redis.replicator.rdb.module.ModuleParser;

import java.io.Closeable;
import java.io.IOException;

/**
 * @author Leon Chen
 * @since 2.1.0
 */
public interface Replicator extends Closeable, ReplicatorListener {
    /*
     * Command
     */
    void builtInCommandParserRegister();

    CommandParser getCommandParser(CommandName command);

     void addCommandParser(CommandName command, CommandParser parser);

    CommandParser removeCommandParser(CommandName command);

    /*
     * Module
     */
    ModuleParser getModuleParser(String moduleName, int moduleVersion);

     void addModuleParser(String moduleName, int moduleVersion, ModuleParser parser);

    ModuleParser removeModuleParser(String moduleName, int moduleVersion);

    /*
     * Rdb
     */
    void setRdbVisitor(RdbVisitor rdbVisitor);

    RdbVisitor getRdbVisitor();

    /*
     *
     */
    boolean verbose();

    /**
     * @return connection status
     * @since 2.4.1
     */
    Status getStatus();

    /**
     * @return configuration
     * @since 2.2.0
     */
    Configuration getConfiguration();

    void open() throws IOException;
}