FilesExpand file tree

 master

/

ClientInterface.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

157 lines (136 loc) · 3.26 KB

 master

/

ClientInterface.php

Copy path

Top

File metadata and controls

• Code
• Blame

157 lines (136 loc) · 3.26 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

<?php

namespace Phpque;

use Phpque\Dto\Job;

use Phpque\Exception\RuntimeException;

interface ClientInterface {

/**

* @return string

*/

public function getNodeId();

/**

* @param string $queueName

* @param string $job

* @param int $msTimeout

* @param array $options

* Hash map of optional arguments: { "OPTION1" => "value", "OPTION" }

*

* @return mixed

*

* @throws RuntimeException

*/

public function addJob($queueName, $job, $msTimeout, array $options = array());

/**

* @param string|string[] $queueNames

* Array or string for single queue

* @param array $options

* Hash map of optional arguments: { "OPTION1" => "value", "OPTION" }

*

* @return Job|null Null if there's no job available

*

* @throws RuntimeException

*/

public function getJob($queueNames, array $options = array());

/**

* @param string|string[] $queueNames

* Array or string for single queue

* @param array $options

* Hash map of optional arguments: { "OPTION1" => "value", "OPTION" }

*

* @return Job[] Empty array if there are no jobs available

*

* @throws RuntimeException

*/

public function getJobs($queueNames, array $options = array());

/**

* @param string $jobId

*

* @return mixed

*

* @throws RuntimeException

*/

public function ackJobById($jobId);

/**

* @param string[] $jobIds

* @return mixed

*

* @throws RuntimeException

*/

public function ackJobsByIds(array $jobIds);

/**

* @param Job $job

*

* @return mixed

*

* @throws RuntimeException

*/

public function ackJob(Job $job);

/**

* @param Job[] $jobs

*

* @return mixed

*

* @throws RuntimeException

*/

public function ackJobs(array $jobs);

/**

* @param string $jobId

*

* @return mixed

*

* @throws RuntimeException

*/

public function fastAckById($jobId);

/**

* @param string[] $jobIds

*

* @return mixed

*

* @throws RuntimeException

*/

public function fastAckByIds(array $jobIds);

/**

* @return mixed

*

* @throws RuntimeException

*/

public function info();

/**

* @return string

*

* @throws RuntimeException

*/

public function ping();

/**

* @return mixed

*

* @throws RuntimeException

*/

public function hello();

/**

* @param string $queueName

*

* @return mixed

*

* @throws RuntimeException

*/

public function qLen($queueName);

/**

* @param string $jobId

*

* @return mixed

*

* @throws RuntimeException

*/

public function show($jobId);

/**

* @param string $name

* @param int $cursor

* @param array $options

* Hash map of optional arguments: { "OPTION1" => "value", "OPTION" }

*

* @return mixed

*

* @throws RuntimeException

*/

public function scan($name, $cursor, array $options = array());

}